org.osgi.service.cm

Class ConfigurationEvent

java.lang.Object

org.osgi.service.cm.ConfigurationEvent

public class ConfigurationEvent
extends Object

A Configuration Event.

ConfigurationEvent objects are delivered to all registered ConfigurationListener service objects. ConfigurationEvents must be asynchronously delivered in chronological order with respect to each listener.

A type code is used to identify the type of event. The following event types are defined:

• CM_UPDATED
• CM_DELETED

Additional event types may be defined in the future.

Security Considerations. ConfigurationEvent objects do not provide Configuration objects, so no sensitive configuration information is available from the event. If the listener wants to locate the Configuration object for the specified pid, it must use ConfigurationAdmin.

Since:

1.2

Version:

$Revision: 809193 $

See Also:

ConfigurationListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	CM_DELETED A Configuration has been deleted.
static int	CM_UPDATED A Configuration has been updated.

Constructor Summary

Constructors

Constructor and Description
ConfigurationEvent(org.osgi.framework.ServiceReference reference, int type, String factoryPid, String pid) Constructs a ConfigurationEvent object from the given ServiceReference object, event type, and pids.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFactoryPid() Returns the factory pid of the associated configuration.
String	getPid() Returns the pid of the associated configuration.
org.osgi.framework.ServiceReference	getReference() Return the ServiceReference object of the Configuration Admin service that created this event.
int	getType() Return the type of this event.

Methods inherited from class java.lang.Object

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

Field Detail

CM_UPDATED

public static final int CM_UPDATED

A Configuration has been updated.

This ConfigurationEvent type that indicates that a Configuration object has been updated with new properties. An event is fired when a call to Configuration.update(Dictionary) successfully changes a configuration.

The value of CM_UPDATED is 1.

See Also:

Constant Field Values

CM_DELETED

public static final int CM_DELETED

A Configuration has been deleted.

This ConfigurationEvent type that indicates that a Configuration object has been deleted. An event is fired when a call to Configuration.delete() successfully deletes a configuration.

The value of CM_DELETED is 2.

See Also:

Constant Field Values

Constructor Detail

ConfigurationEvent

public ConfigurationEvent(org.osgi.framework.ServiceReference reference,
                  int type,
                  String factoryPid,
                  String pid)

Constructs a ConfigurationEvent object from the given ServiceReference object, event type, and pids.

Parameters:

reference - The ServiceReference object of the Configuration Admin service that created this event.

type - The event type. See getType().

factoryPid - The factory pid of the associated configuration if the target of the configuration is a ManagedServiceFactory. Otherwise null if the target of the configuration is a ManagedService.

pid - The pid of the associated configuration.

Method Detail

getFactoryPid

public String getFactoryPid()

Returns the factory pid of the associated configuration.

Returns:

Returns the factory pid of the associated configuration if the target of the configuration is a ManagedServiceFactory. Otherwise null if the target of the configuration is a ManagedService.

getPid

public String getPid()

Returns the pid of the associated configuration.

Returns:

Returns the pid of the associated configuration.

getType

public int getType()

Return the type of this event.

The type values are:

• CM_UPDATED
• CM_DELETED

Returns:

The type of this event.

getReference

public org.osgi.framework.ServiceReference getReference()

Return the ServiceReference object of the Configuration Admin service that created this event.

Returns:

The ServiceReference object for the Configuration Admin service that created this event.