Top Description Fields Constructors Methods
org.osgi.framework

public Class FrameworkEvent

extends EventObject
Class Inheritance
Imports
java.util.EventObject, org.osgi.framework.startlevel.FrameworkStartLevel, org.osgi.framework.wiring.FrameworkWiring

A general event from the Framework.

FrameworkEvent objects are delivered to FrameworkListeners when a general event occurs within the OSGi environment. A type code is used to identify the event type for future extendability.

OSGi Alliance reserves the right to extend the set of event types.

Author
$Id: 7b74a68311acf2116ccf21e589ece0ce2cd383ba $
See Also
FrameworkListener

Field Summary

Modifier and TypeField and Description
private final Bundle
bundle

Bundle related to the event.

public static final int
ERROR

An error has occurred.

public static final int
INFO

An informational event has occurred.

public static final int
PACKAGES_REFRESHED

A FrameworkWiring.refreshBundles operation has completed.

pack-priv static final long
public static final int
STARTED

The Framework has started.

public static final int
STARTLEVEL_CHANGED

A FrameworkStartLevel.setStartLevel operation has completed.

public static final int
STOPPED

The Framework has stopped.

public static final int
STOPPED_BOOTCLASSPATH_MODIFIED

The Framework has stopped and the boot class path has changed.

public static final int
STOPPED_UPDATE

The Framework has stopped during update.

private final Throwable
throwable

Exception related to the event.

private final int
type

Type of event.

public static final int
WAIT_TIMEDOUT

The Framework did not stop before the wait timeout expired.

public static final int
WARNING

A warning has occurred.

Inherited from java.util.EventObject:
source

Constructor Summary

AccessConstructor and Description
public
FrameworkEvent(int
The event type.
type
,
Object
The event source object. This may not be null.
source
)
Deprecated As of 1.2. This constructor is deprecated in favor of using the other constructor with the System Bundle as the event source.

Creates a Framework event.

public
FrameworkEvent(int
The event type.
type
,
Bundle
The event source.
bundle
,
Throwable
The related exception. This argument may be null if there is no related exception.
throwable
)

Creates a Framework event regarding the specified bundle.

Method Summary

Modifier and TypeMethod and Description
public Bundle

Returns:

The bundle associated with the event.
getBundle
()

Returns the bundle associated with the event.

public Throwable

Returns:

The related exception or null if none.
getThrowable
()

Returns the exception related to this event.

public int

Returns:

The type of state change.
getType
()

Returns the type of framework event.

Inherited from java.util.EventObject:
getSourcetoString

Field Detail

bundleback to summary
private final Bundle bundle

Bundle related to the event.

ERRORback to summary
public static final int ERROR

An error has occurred.

There was an error associated with a bundle.

INFOback to summary
public static final int INFO

An informational event has occurred.

There was an informational event associated with a bundle.

Since
1.3
PACKAGES_REFRESHEDback to summary
public static final int PACKAGES_REFRESHED

A FrameworkWiring.refreshBundles operation has completed.

This event is fired when the Framework has completed the refresh bundles operation initiated by a call to the FrameworkWiring.refreshBundles method. The source of this event is the System Bundle.

Since
1.2
See Also
FrameworkWiring#refreshBundles(java.util.Collection, FrameworkListener...)
serialVersionUIDback to summary
pack-priv static final long serialVersionUID

Hides java.util.EventObject.serialVersionUID.

STARTEDback to summary
public static final int STARTED

The Framework has started.

This event is fired when the Framework has started after all installed bundles that are marked to be started have been started and the Framework has reached the initial start level. The source of this event is the System Bundle.

See Also
The Start Level Specification
STARTLEVEL_CHANGEDback to summary
public static final int STARTLEVEL_CHANGED

A FrameworkStartLevel.setStartLevel operation has completed.

This event is fired when the Framework has completed changing the active start level initiated by a call to the StartLevel.setStartLevel method. The source of this event is the System Bundle.

Since
1.2
See Also
FrameworkStartLevel#setStartLevel(int, FrameworkListener...)
STOPPEDback to summary
public static final int STOPPED

The Framework has stopped.

This event is fired when the Framework has been stopped because of a stop operation on the system bundle. The source of this event is the System Bundle.

Since
1.5
STOPPED_BOOTCLASSPATH_MODIFIEDback to summary
public static final int STOPPED_BOOTCLASSPATH_MODIFIED

The Framework has stopped and the boot class path has changed.

This event is fired when the Framework has been stopped because of a stop operation on the system bundle and a bootclasspath extension bundle has been installed or updated. The source of this event is the System Bundle.

Since
1.5
STOPPED_UPDATEback to summary
public static final int STOPPED_UPDATE

The Framework has stopped during update.

This event is fired when the Framework has been stopped because of an update operation on the system bundle. The Framework will be restarted after this event is fired. The source of this event is the System Bundle.

Since
1.5
throwableback to summary
private final Throwable throwable

Exception related to the event.

typeback to summary
private final int type

Type of event.

WAIT_TIMEDOUTback to summary
public static final int WAIT_TIMEDOUT

The Framework did not stop before the wait timeout expired.

This event is fired when the Framework did not stop before the wait timeout expired. The source of this event is the System Bundle.

Since
1.5
WARNINGback to summary
public static final int WARNING

A warning has occurred.

There was a warning associated with a bundle.

Since
1.3

Constructor Detail

FrameworkEventback to summary
public FrameworkEvent(int type, Object source)

Deprecated

As of 1.2. This constructor is deprecated in favor of using the other constructor with the System Bundle as the event source.

Creates a Framework event.

Parameters
type:int

The event type.

source:Object

The event source object. This may not be null.

FrameworkEventback to summary
public FrameworkEvent(int type, Bundle bundle, Throwable throwable)

Creates a Framework event regarding the specified bundle.

Parameters
type:int

The event type.

bundle:Bundle

The event source.

throwable:Throwable

The related exception. This argument may be null if there is no related exception.

Method Detail

getBundleback to summary
public Bundle getBundle()

Returns the bundle associated with the event. This bundle is also the source of the event.

Returns:Bundle

The bundle associated with the event.

getThrowableback to summary
public Throwable getThrowable()

Returns the exception related to this event.

Returns:Throwable

The related exception or null if none.

getTypeback to summary
public int getType()

Returns the type of framework event.

The type values are:

Returns:int

The type of state change.