OSGi 8.1.0 · org.osgi.framework.ServiceEvent · APIdia, the JavaDoc alternative

An event from the Framework describing a service lifecycle change.

ServiceEvent objects are delivered to ServiceListeners and AllServiceListeners when a change occurs in this service's lifecycle. A type code is used to identify the event type for future extendability.

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

Field Summary

Modifier and Type	Field and Description
public static final int	MODIFIED The properties of a registered service have been modified.
public static final int	MODIFIED_ENDMATCH The properties of a registered service have been modified and the new properties no longer match the listener's filter.
private final ServiceReference<?>	reference Reference to the service that had a change occur in its lifecycle.
public static final int	REGISTERED This service has been registered.
pack-priv static final long	serialVersionUID Hides java.util.EventObject.serialVersionUID.
private final int	type Type of service lifecycle change.
public static final int	UNREGISTERING This service is in the process of being unregistered.

Inherited from java.util.EventObject:: source

Constructor Summary

Access	Constructor and Description
public	ServiceEvent(int The event type. type, ServiceReference<?> A `ServiceReference` object to the service that had a lifecycle change. reference) Creates a new service event object.

Method Summary

Modifier and Type	Method and Description
public ServiceReference<?>	Returns: Reference to the service that had a lifecycle change. getServiceReference() Returns a reference to the service that had a change occur in its lifecycle.
public int	Returns: Type of service lifecycle change. getType() Returns the type of event.

Inherited from java.util.EventObject:: getSource toString

Field Detail

MODIFIED back to summary

MODIFIED	back to summary
public static final int MODIFIED The properties of a registered service have been modified. This event is synchronously delivered after the service properties have been modified. See Also `ServiceRegistration#setProperties(Dictionary)`

public static final int MODIFIED

The properties of a registered service have been modified.

This event is synchronously delivered after the service properties have been modified.

See Also: ServiceRegistration#setProperties(Dictionary)

MODIFIED_ENDMATCH back to summary

MODIFIED_ENDMATCH	back to summary
public static final int MODIFIED_ENDMATCH The properties of a registered service have been modified and the new properties no longer match the listener's filter. This event is synchronously delivered after the service properties have been modified. This event is only delivered to listeners which were added with a non-`null` filter where the filter matched the service properties prior to the modification but the filter does not match the modified service properties. Since 1.5 See Also `ServiceRegistration#setProperties(Dictionary)`

public static final int MODIFIED_ENDMATCH

The properties of a registered service have been modified and the new properties no longer match the listener's filter.

This event is synchronously delivered after the service properties have been modified. This event is only delivered to listeners which were added with a non-null filter where the filter matched the service properties prior to the modification but the filter does not match the modified service properties.

Since: 1.5
See Also: ServiceRegistration#setProperties(Dictionary)

reference	back to summary
private final ServiceReference<?> reference Reference to the service that had a change occur in its lifecycle.

REGISTERED back to summary

REGISTERED	back to summary
public static final int REGISTERED This service has been registered. This event is synchronously delivered after the service has been registered with the Framework. See Also `BundleContext#registerService(String[], Object, Dictionary)`

public static final int REGISTERED

This service has been registered.

This event is synchronously delivered after the service has been registered with the Framework.

See Also: BundleContext#registerService(String[], Object, Dictionary)

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.util.EventObject.serialVersionUID.

type	back to summary
private final int type Type of service lifecycle change.

UNREGISTERING back to summary

UNREGISTERING	back to summary
public static final int UNREGISTERING This service is in the process of being unregistered. This event is synchronously delivered before the service has completed unregistering. If a bundle is using a service that is `UNREGISTERING`, the bundle should release its use of the service when it receives this event. If the bundle does not release its use of the service when it receives this event, the Framework will automatically release the bundle's use of the service while completing the service unregistration operation. See Also `ServiceRegistration#unregister()`, `BundleContext#ungetService(ServiceReference)`

public static final int UNREGISTERING

This service is in the process of being unregistered.

This event is synchronously delivered before the service has completed unregistering.

If a bundle is using a service that is UNREGISTERING, the bundle should release its use of the service when it receives this event. If the bundle does not release its use of the service when it receives this event, the Framework will automatically release the bundle's use of the service while completing the service unregistration operation.

See Also: ServiceRegistration#unregister(), BundleContext#ungetService(ServiceReference)

Constructor Detail

ServiceEvent back to summary

ServiceEvent	back to summary
public ServiceEvent(int type, ServiceReference<?> reference) Creates a new service event object. Parameters type:int The event type. reference:ServiceReference<?> A `ServiceReference` object to the service that had a lifecycle change.

public ServiceEvent(int type, ServiceReference<?> reference)

Creates a new service event object.

Parameters

type:int: The event type.
reference:ServiceReference<?>: A ServiceReference object to the service that had a lifecycle change.

Method Detail

getServiceReference	back to summary
public ServiceReference<?> getServiceReference() Returns a reference to the service that had a change occur in its lifecycle. This reference is the source of the event. Returns:ServiceReference<?> Reference to the service that had a lifecycle change.

getServiceReference

back to summary

public ServiceReference<?> getServiceReference()

Returns a reference to the service that had a change occur in its lifecycle.

This reference is the source of the event.

Returns:ServiceReference<?>: Reference to the service that had a lifecycle change.

getType back to summary

getType	back to summary
public int getType() Returns the type of event. The event type values are: `REGISTERED` `MODIFIED` `MODIFIED_ENDMATCH` `UNREGISTERING` Returns:int Type of service lifecycle change.

public int getType()

Returns the type of event. The event type values are:

Returns:int: Type of service lifecycle change.