org.jahia.osgi

Class FrameworkService

java.lang.Object

org.jahia.osgi.FrameworkService

All Implemented Interfaces:

EventListener, org.osgi.framework.FrameworkListener

public final 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_CLUSTER_STARTED
static String	EVENT_TYPE_CLUSTERING_FEATURE_INSTALLED
static String	EVENT_TYPE_FILEINSTALL_STARTED
static String	EVENT_TYPE_FINAL_START_LEVEL_REACHED
static String	EVENT_TYPE_INITIAL_START_LEVEL_REACHED
static String	EVENT_TYPE_SPRING_BRIDGE_STARTED

Method Summary

Modifier and Type	Method and Description
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.
void	notifyClusterStarted() Notifies the service that the FileInstall watcher has been started and processed the found modules.
void	notifyFileInstallStarted(List<Long> createdOnStartup) Notifies the service that the FileInstall watcher has been started and processed the found modules.
void	notifyFinalStartLevelReached() Notifies the service that the Spring bridge has been started
void	notifyInitialStartLevelReached() Notifies the service that the Initial start leve has been reached
void	notifySpringBridgeStarted() Notifies the service that the Spring bridge has been started
void	raiseStartLevel() Raise the start level to its final state
static void	sendEvent(String topic, Map<String,?> properties, boolean asynchronous) Initiate synchronous or asynchronous delivery of an OSGi event using EventAdmin service.
void	start() Start framework
void	stop() Shuts the OSGi container down.
void	waitForClusterStarted() Wait for cluster sync to be finished
void	waitForFileInstallStarted() Wait for fileinstall
void	waitForFinalStartLevelReached() Wait for final start level to be reached
void	waitForInitialStartLevelReached() Wait for initial start level to be reached
void	waitForSpringBridgeStarted() Wait for Spring bridge to be started

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_INITIAL_START_LEVEL_REACHED

public static final String EVENT_TYPE_INITIAL_START_LEVEL_REACHED

See Also:

Constant Field Values

EVENT_TYPE_FILEINSTALL_STARTED

public static final String EVENT_TYPE_FILEINSTALL_STARTED

See Also:

Constant Field Values

EVENT_TYPE_SPRING_BRIDGE_STARTED

public static final String EVENT_TYPE_SPRING_BRIDGE_STARTED

See Also:

Constant Field Values

EVENT_TYPE_CLUSTER_STARTED

public static final String EVENT_TYPE_CLUSTER_STARTED

See Also:

Constant Field Values

EVENT_TYPE_FINAL_START_LEVEL_REACHED

public static final String EVENT_TYPE_FINAL_START_LEVEL_REACHED

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

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

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()

Start framework

stop

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

Shuts the OSGi container down.

Throws:

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

frameworkEvent

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

Specified by:

frameworkEvent in interface org.osgi.framework.FrameworkListener

notifyInitialStartLevelReached

public void notifyInitialStartLevelReached()

Notifies the service that the Initial start leve has been reached

waitForInitialStartLevelReached

public void waitForInitialStartLevelReached()

Wait for initial start level to be reached

notifyFileInstallStarted

public void notifyFileInstallStarted(List<Long> createdOnStartup)

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

Parameters:

createdOnStartup - List of bundles that have installed by fileinstall

waitForFileInstallStarted

public void waitForFileInstallStarted()

Wait for fileinstall

notifySpringBridgeStarted

public void notifySpringBridgeStarted()

Notifies the service that the Spring bridge has been started

waitForSpringBridgeStarted

public void waitForSpringBridgeStarted()

Wait for Spring bridge to be started

raiseStartLevel

public void raiseStartLevel()

Raise the start level to its final state

notifyFinalStartLevelReached

public void notifyFinalStartLevelReached()

Notifies the service that the Spring bridge has been started

waitForFinalStartLevelReached

public void waitForFinalStartLevelReached()

Wait for final start level to be reached

notifyClusterStarted

public void notifyClusterStarted()

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

waitForClusterStarted

public void waitForClusterStarted()

Wait for cluster sync to be finished