? BlueprintEvent
BlueprintEvent
objects are delivered to all registered
BlueprintListener
services. Blueprint Events must be asynchronously
delivered in chronological order with respect to each listener.
In addition, after a Blueprint Listener is registered, the Blueprint extender
will synchronously send to this Blueprint Listener the last Blueprint Event
for each ready Blueprint bundle managed by this extender. This
replay of Blueprint Events is designed so that the new Blueprint
Listener can be informed of the state of each Blueprint bundle. Blueprint
Events sent during this replay will have the isReplay()
flag set.
The Blueprint extender must ensure that this replay phase does not interfere
with new Blueprint Events so that the chronological order of all Blueprint
Events received by the Blueprint Listener is preserved. If the last Blueprint
Event for a given Blueprint bundle is DESTROYED
, the extender must
not send it during this replay phase.
A type code is used to identify the type of event. The following event types are defined:
In addition to calling the registered BlueprintListener
services, the
Blueprint extender must also send those events to the Event Admin service, if
it is available.
-
????
????????????static final int
The Blueprint extender has created a Blueprint Container for the bundle.static final int
The Blueprint extender has started creating a Blueprint Container for the bundle.static final int
The Blueprint Container for the bundle has been completely destroyed.static final int
The Blueprint extender has started destroying the Blueprint Container for the bundle.static final int
The Blueprint Container creation for the bundle has failed.static final int
The Blueprint Container has entered the grace period.static final int
The Blueprint Container is waiting on the availability of a service to satisfy an invocation on a referenced service. -
?????
????????BlueprintEvent
(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle) Create a simpleBlueprintEvent
object.BlueprintEvent
(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle, String[] dependencies) Create aBlueprintEvent
object associated with a set of dependencies.BlueprintEvent
(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle, String[] dependencies, Throwable cause) Create aBlueprintEvent
object associated with a failure cause and a set of dependencies.BlueprintEvent
(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle, Throwable cause) Create aBlueprintEvent
object associated with a failure cause.BlueprintEvent
(BlueprintEvent event, boolean replay) Create a newBlueprintEvent
from the specifiedBlueprintEvent
. -
????
??????????org.osgi.framework.Bundle
Return the Blueprint bundle associated with this event.getCause()
Return the cause for thisFAILURE
event.String[]
Return the filters identifying the missing dependencies that caused this event.org.osgi.framework.Bundle
Return the Blueprint extender bundle that is generating this event.long
Return the time at which this event was created.int
getType()
Return the type of this event.boolean
isReplay()
Return whether this event is a replay event.
-
??????
-
CREATING
public static final int CREATINGThe Blueprint extender has started creating a Blueprint Container for the bundle.- ????:
-
CREATED
public static final int CREATEDThe Blueprint extender has created a Blueprint Container for the bundle. This event is sent after the Blueprint Container has been registered as a service.- ????:
-
DESTROYING
public static final int DESTROYINGThe Blueprint extender has started destroying the Blueprint Container for the bundle.- ????:
-
DESTROYED
public static final int DESTROYEDThe Blueprint Container for the bundle has been completely destroyed. This event is sent after the Blueprint Container has been unregistered as a service.- ????:
-
FAILURE
public static final int FAILUREThe Blueprint Container creation for the bundle has failed. If this event is sent after a timeout in the Grace Period, thegetDependencies()
method must return an array of missing mandatory dependencies. The event must also contain the cause of the failure as aThrowable
through thegetCause()
method.- ????:
-
GRACE_PERIOD
public static final int GRACE_PERIODThe Blueprint Container has entered the grace period. The list of missing dependencies must be made available through thegetDependencies()
method. During the grace period, aGRACE_PERIOD
event is sent each time the set of unsatisfied dependencies changes.- ????:
-
WAITING
public static final int WAITINGThe Blueprint Container is waiting on the availability of a service to satisfy an invocation on a referenced service. The missing dependency must be made available through thegetDependencies()
method which will return an array containing one filter object as a String.- ????:
-
-
???????
-
BlueprintEvent
public BlueprintEvent(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle) Create a simpleBlueprintEvent
object.- ??:
type
- The type of this event.bundle
- The Blueprint bundle associated with this event. This parameter must not benull
.extenderBundle
- The Blueprint extender bundle that is generating this event. This parameter must not benull
.
-
BlueprintEvent
public BlueprintEvent(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle, String[] dependencies) Create aBlueprintEvent
object associated with a set of dependencies.- ??:
type
- The type of this event.bundle
- The Blueprint bundle associated with this event. This parameter must not benull
.extenderBundle
- The Blueprint extender bundle that is generating this event. This parameter must not benull
.dependencies
- An array ofString
filters for each dependency associated with this event. Must be a non-empty array for event typesGRACE_PERIOD
andWAITING
. It is optional for event typeFAILURE
. Must benull
for other event types.
-
BlueprintEvent
public BlueprintEvent(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle, Throwable cause) Create aBlueprintEvent
object associated with a failure cause.- ??:
type
- The type of this event.bundle
- The Blueprint bundle associated with this event. This parameter must not benull
.extenderBundle
- The Blueprint extender bundle that is generating this event. This parameter must not benull
.cause
- AThrowable
object describing the root cause of the event. May benull
.
-
BlueprintEvent
public BlueprintEvent(int type, org.osgi.framework.Bundle bundle, org.osgi.framework.Bundle extenderBundle, String[] dependencies, Throwable cause) Create aBlueprintEvent
object associated with a failure cause and a set of dependencies.- ??:
type
- The type of this event.bundle
- The Blueprint bundle associated with this event. This parameter must not benull
.extenderBundle
- The Blueprint extender bundle that is generating this event. This parameter must not benull
.dependencies
- An array ofString
filters for each dependency associated with this event. Must be a non-empty array for event typesGRACE_PERIOD
andWAITING
. It is optional for event typeFAILURE
. Must benull
for other event types.cause
- AThrowable
object describing the root cause of this event. May benull
.
-
BlueprintEvent
Create a newBlueprintEvent
from the specifiedBlueprintEvent
. Thetimestamp
property will be copied from the original event and only the replay property will be overridden with the given value.- ??:
event
- The originalBlueprintEvent
to copy. Must not benull
.replay
-true
if this event should be used as a replay event.
-
-
??????
-
getType
public int getType()Return the type of this event.The type values are:
- ??:
- The type of this event.
-
getTimestamp
public long getTimestamp()Return the time at which this event was created.- ??:
- The time at which this event was created.
-
getBundle
public org.osgi.framework.Bundle getBundle()Return the Blueprint bundle associated with this event.- ??:
- The Blueprint bundle associated with this event.
-
getExtenderBundle
public org.osgi.framework.Bundle getExtenderBundle()Return the Blueprint extender bundle that is generating this event.- ??:
- The Blueprint extender bundle that is generating this event.
-
getDependencies
Return the filters identifying the missing dependencies that caused this event.- ??:
- The filters identifying the missing dependencies that caused this
event if the event type is one of
WAITING
,GRACE_PERIOD
orFAILURE
ornull
for the other event types.
-
getCause
Return the cause for thisFAILURE
event.- ??:
- The cause of the failure for this event. May be
null
.
-
isReplay
public boolean isReplay()Return whether this event is a replay event.- ??:
true
if this event is a replay event andfalse
otherwise.
-