Examples of org.osgi.service.cm.ConfigurationAdmin

org.osgi.service.cm.ConfigurationAdmin
Service for administering configuration data.
The main purpose of this interface is to store bundle configuration data persistently. This information is represented in {@code Configuration}objects. The actual configuration data is a {@code Dictionary} of propertiesinside a {@code Configuration} object.
There are two principally different ways to manage configurations. First there is the concept of a Managed Service, where configuration data is uniquely associated with an object registered with the service registry.
Next, there is the concept of a factory where the Configuration Admin service will maintain 0 or more {@code Configuration} objects for a Managed ServiceFactory that is registered with the Framework.
The first concept is intended for configuration data about "things/services" whose existence is defined externally, e.g. a specific printer. Factories are intended for "things/services" that can be created any number of times, e.g. a configuration for a DHCP server for different networks.
Bundles that require configuration should register a Managed Service or a Managed Service Factory in the service registry. A registration property named {@code service.pid} (persistent identifier or PID) must be used toidentify this Managed Service or Managed Service Factory to the Configuration Admin service.
When the ConfigurationAdmin detects the registration of a Managed Service, it checks its persistent storage for a configuration object whose {@code service.pid} property matches the PID service property ({@code service.pid}) of the Managed Service. If found, it calls {@link ManagedService#updated(Dictionary)} method with the new properties.The implementation of a Configuration Admin service must run these call-backs asynchronously to allow proper synchronization.
When the Configuration Admin service detects a Managed Service Factory registration, it checks its storage for configuration objects whose {@code service.factoryPid} property matches the PID service property of theManaged Service Factory. For each such {@code Configuration} objects, itcalls the {@code ManagedServiceFactory.updated} method asynchronously withthe new properties. The calls to the {@code updated} method of a{@code ManagedServiceFactory} must be executed sequentially and not overlapin time.
In general, bundles having permission to use the Configuration Admin service can only access and modify their own configuration information. Accessing or modifying the configuration of other bundles requires {@code ConfigurationPermission[location,CONFIGURE]}, where location is the configuration location.
{@code Configuration} objects can be bound to a specified bundlelocation or to a region (configuration location starts with {@code ?}). If a location is not set, it will be learned the first time a target is registered. If the location is learned this way, the Configuration Admin service must detect if the bundle corresponding to the location is uninstalled. If this occurs, the {@code Configuration} object must beunbound, that is its location field is set back to {@code null}.
If target's bundle location matches the configuration location it is always updated.
If the configuration location starts with {@code ?}, that is, the location is a region, then the configuration must be delivered to all targets registered with the given PID. If security is on, the target bundle must have Configuration Permission[location,TARGET], where location matches given the configuration location with wildcards as in the Filter substring match. The security must be verified using the {@link org.osgi.framework.Bundle#hasPermission(Object)} method on the targetbundle.
If a target cannot be updated because the location does not match or it has no permission and security is active then the Configuration Admin service must not do the normal callback.
The method descriptions of this class refer to a concept of "the calling bundle". This is a loose way of referring to the bundle which obtained the Configuration Admin service from the service registry. Implementations of {@code ConfigurationAdmin} must use a{@link org.osgi.framework.ServiceFactory} to support this concept. @noimplement @author $Id: cf748cd876c4ff2f88ca7f88ca0030cd1ce94bef $

  /**
   * @see org.apache.felix.jmood.compendium.ConfigAdminManagerMBean#createFactoryConfiguration(java.lang.String, java.lang.String)
   */
  public String createFactoryConfiguration(String pid, String location)
    throws Exception {
    ConfigurationAdmin cad=ac.getConfigurationAdmin();
    if (cad != null) {
      Configuration conf = cad.createFactoryConfiguration(pid, location);
      refresh();
      return this.getObjectName(conf);
    } else
      return null;
  }

View Full Code Here

   *  Delete the configurations identified by the LDAP filter
   * @param filter LDAP String representing the configurations that want to be deleted 
   * @see org.apache.felix.jmood.compendium.ConfigAdminManagerMBean#deleteConfigurations(java.lang.String)
   */
  public void deleteConfigurations(String filter) throws Exception {
    ConfigurationAdmin cad=ac.getConfigurationAdmin();
    Configuration[] confs = null;
    if (cad!= null) {
      confs = cad.listConfigurations(filter);
    }
    if (confs != null)
      for (int i = 0; i < confs.length; i++) {
        confs[i].delete();
      }

View Full Code Here

   * Removes a property from all the configurations selected by an LDAP expression 
   * @see org.apache.felix.jmood.compendium.ConfigAdminManagerMBean#removePropertyFromConfigurations(java.lang.String, java.lang.String)
   */
  public void removePropertyFromConfigurations(String filter, String name)
    throws Exception {
    ConfigurationAdmin cad=ac.getConfigurationAdmin();
    Configuration[] confs = null;
    if (cad != null) {
      confs = cad.listConfigurations(filter);
    }
    if (confs != null)
      for (int i = 0; i < confs.length; i++) {
        Dictionary dic = confs[i].getProperties();
        Enumeration keys = dic.keys();

View Full Code Here

    String name,
    String value,
    String type)
    throws Exception {
    if (isValidType(type)) {
      ConfigurationAdmin cad=ac.getConfigurationAdmin();
      Configuration[] confs = null;
      if (cad != null) {
        confs = cad.listConfigurations(filter);
      }
      if (confs != null)
        for (int i = 0; i < confs.length; i++) {
          Dictionary dic = confs[i].getProperties();
          dic.put(name, castValueToType(type, value));

View Full Code Here

      // Unsupported type
      return null;
    }
  }
    private void registerMBeans() throws Exception{
        ConfigurationAdmin cad=ac.getConfigurationAdmin();
        if (cad==null) {
            ac.debug("could not add any conf mbean, conf admin not available");
            return;
        }
            ac.debug("creating mbeans for existing config objects");
            Configuration[] confs = null;
            //confs contains the new config objects
            //The old ones are in configObjects, whose key is the object name.
            confs = cad.listConfigurations(null);
            if (confs!=null) {
                ac.debug("Existing conf objects: ");
            for(int i=0;i<confs.length;i++) {
                ac.debug("\t"+confs[i].getPid());
                //now we add the new ones

View Full Code Here

                {
                    try
                    {
                        if ( cao instanceof ConfigurationAdmin )
                        {
                            final ConfigurationAdmin ca = ( ConfigurationAdmin ) cao;
                            for (String confPid: confPids )
                            {
                                final Collection<Configuration> factory = findFactoryConfigurations( ca, confPid,
                                        bundleContext.getBundle() );
                                if ( !factory.isEmpty() )

View Full Code Here

                {
                    try
                    {
                        if ( cao instanceof ConfigurationAdmin )
                        {
                            final ConfigurationAdmin ca = ( ConfigurationAdmin ) cao;
                            final Configuration config = getConfiguration( ca, pid.getRawPid() );
                            return new ConfigurationInfo(config.getProperties(), config.getBundleLocation(),
                                    changeCounter.getChangeCount( config, true, componentHolder.getChangeCount( pid, targetedPid ) ) );
                        }
                        else

View Full Code Here

            "  </Designate>\n" + 
            "</MetaData>\n";
        p.process("basic", new ByteArrayInputStream(config.getBytes()));
        p.prepare();
        p.commit();
        p.addConfigurationAdmin(null, new ConfigurationAdmin() {
            public Configuration[] listConfigurations(String filter) throws IOException, InvalidSyntaxException {
                return null;
            }
            
            public Configuration getConfiguration(String pid, String location) throws IOException {

View Full Code Here

        p.prepare();
        p.commit();
        Properties props = new Properties();
        props.put("id", Integer.valueOf(42));
        final Configuration configuration = new ConfigurationImpl();
        p.addConfigurationAdmin(new Reference(props), new ConfigurationAdmin() {
            public Configuration[] listConfigurations(String filter) throws IOException, InvalidSyntaxException {
                return null;
            }
            
            public Configuration getConfiguration(String pid, String location) throws IOException {
                return configuration;
            }
            
            public Configuration getConfiguration(String pid) throws IOException {
                return null;
            }
            
            public Configuration createFactoryConfiguration(String factoryPid, String location) throws IOException {
                return null;
            }
            
            public Configuration createFactoryConfiguration(String factoryPid) throws IOException {
                return null;
            }
        });
        
        final Configuration emptyConfiguration = new ConfigurationImpl();
        p.addConfigurationAdmin(new Reference(new Properties()), new ConfigurationAdmin() {
            public Configuration[] listConfigurations(String filter) throws IOException, InvalidSyntaxException {
                return null;
            }
            
            public Configuration getConfiguration(String pid, String location) throws IOException {

View Full Code Here

    }


    public synchronized void notifyChange() {
        // check if all services are available
        final ResourceChangeListener listener = (ResourceChangeListener)this.changeHandlerListener.getService();
        final ConfigurationAdmin configAdmin = (ConfigurationAdmin)this.configAdminListener.getService();


        if ( configAdmin != null && listener != null ) {
            if ( configTaskCreator == null ) {
                final Hashtable<String, String> props = new Hashtable<String, String>();
                props.put(Constants.SERVICE_DESCRIPTION, "Apache Sling Configuration Install Task Factory");

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.osgi.service.cm.ConfigurationAdmin

ch.entwine.weblounge.contentrepository.impl.ContentRepositoryServiceFactory

io.fabric8.fab.osgi.util.ConfigurationAdminHelperTest

io.fabric8.itests.smoke.embedded.RemoteGitRepositoryTest

org.apache.ace.it.IntegrationTestBase

org.apache.aries.blueprint.compendium.cm.ManagedServiceFactoryTest

org.apache.aries.blueprint.itests.BlueprintContainer2BTCustomizerTest

org.apache.aries.blueprint.itests.BlueprintContainer2Test

org.apache.aries.blueprint.itests.BlueprintContainerBTCustomizerTest

org.apache.aries.blueprint.itests.BlueprintContainerTest

org.apache.aries.blueprint.itests.TestConfigAdmin

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.