Package org.codice.ddf.admin.configuration.plugin

Class ConfigPidConfigurationPlugin

java.lang.Object
org.codice.ddf.admin.configuration.plugin.ConfigPidConfigurationPlugin
All Implemented Interfaces:
org.osgi.service.cm.ConfigurationPlugin
public class ConfigPidConfigurationPlugin extends Object implements org.osgi.service.cm.ConfigurationPlugin
A configuration plugin that passes the configuration's PID to the created Service so that the Service and its Configuration can be correlated in the future.

  • Field Summary

    Fields inherited from interface org.osgi.service.cm.ConfigurationPlugin

    CM_RANKING, CM_TARGET

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConfigPidConfigurationPlugin()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    modifyConfiguration(org.osgi.framework.ServiceReference<?> reference, Dictionary<String,Object> properties)
    When a user creates/modifies a configuration (e.g., via the Felix Web Console Configuration Manager), this method is invoked prior to the ManagedService.updated(Dictionary) method to add a configuration PID to the Dictionary.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ConfigPidConfigurationPlugin

      public ConfigPidConfigurationPlugin()

  • Method Details

    • modifyConfiguration

      public void modifyConfiguration(org.osgi.framework.ServiceReference<?> reference, Dictionary<String,Object> properties)
      When a user creates/modifies a configuration (e.g., via the Felix Web Console Configuration Manager), this method is invoked prior to the ManagedService.updated(Dictionary) method to add a configuration PID to the Dictionary. If the bean that is getting created/modified has a setConfigurationPid(java.lang.String) method and the ManagedService/ManagedServiceFactory utilizes a container-managed update strategy, the configuration PID will subsequently be injected into the bean.
      Specified by:
      modifyConfiguration in interface org.osgi.service.cm.ConfigurationPlugin
      Parameters:
      reference - Reference to the Managed Service or Managed Service Factory
      properties - The configuration properties. This argument must not contain the "service.bundleLocation" property. The value of this property may be obtained from the Configuration.getBundleLocation method