Interface ManagedService
-
public interface ManagedServiceA service that can receive configuration data from a Configuration Admin service.A Managed Service is a service that needs configuration data. Such an object should be registered with the Framework registry with the
service.pidproperty set to some unique identifier called a PID.If the Configuration Admin service has a
Configurationobject corresponding to this PID, it will callback theupdated()method of theManagedServiceobject, passing the properties of thatConfigurationobject.If it has no such
Configurationobject, then it calls back with anullproperties argument. Registering a Managed Service will always result in a callback to theupdated()method provided the Configuration Admin service is, or becomes active. This callback must always be done asynchronously.Else, every time that either of the
updated()methods is called on thatConfigurationobject, theManagedService.updated()method with the new properties is called. If thedelete()method is called on thatConfigurationobject,ManagedService.updated()is called with anullfor the properties parameter. All these callbacks must be done asynchronously.The following example shows the code of a serial port that will create a port depending on configuration information.
class SerialPort implements ManagedService { ServiceRegistration registration; Hashtable configuration; CommPortIdentifier id; synchronized void open(CommPortIdentifier id, BundleContext context) { this.id = id; registration = context.registerService( ManagedService.class.getName(), this, getDefaults() ); } Hashtable getDefaults() { Hashtable defaults = new Hashtable(); defaults.put( "port", id.getName() ); defaults.put( "product", "unknown" ); defaults.put( "baud", "9600" ); defaults.put( Constants.SERVICE_PID, "com.acme.serialport." + id.getName() ); return defaults; } public synchronized void updated( Dictionary configuration ) { if ( configuration ==null) registration.setProperties( getDefaults() ); else { setSpeed( configuration.get("baud") ); registration.setProperties( configuration ); } } ... }As a convention, it is recommended that when a Managed Service is updated, it should copy all the properties it does not recognize into the service registration properties. This will allow the Configuration Admin service to set properties on services which can then be used by other applications.
- Version:
- $Revision: 5673 $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidupdated(java.util.Dictionary properties)Update the configuration for a Managed Service.
-
-
-
Method Detail
-
updated
void updated(java.util.Dictionary properties) throws ConfigurationExceptionUpdate the configuration for a Managed Service.When the implementation of
updated(Dictionary)detects any kind of error in the configuration properties, it should create a newConfigurationExceptionwhich describes the problem. This can allow a management system to provide useful information to a human administrator.If this method throws any other
Exception, the Configuration Admin service must catch it and should log it.The Configuration Admin service must call this method asynchronously which initiated the callback. This implies that implementors of Managed Service can be assured that the callback will not take place during registration when they execute the registration in a synchronized method.
- Parameters:
properties- A copy of the Configuration properties, ornull. This argument must not contain the "service.bundleLocation" property. The value of this property may be obtained from theConfiguration.getBundleLocationmethod.- Throws:
ConfigurationException- when the update fails
-
-