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 $

                if (logFile == null) {
                    throw new ConfigurationException(LogConfigManager.LOG_FILE,
                            "LogFile name has to be specified.");
                }
                // try to get the configadmin
                final ConfigurationAdmin configAdmin = (ConfigurationAdmin) this.bundleContext
                        .getService(sr);
                if (configAdmin != null) {
                    Configuration config;
                    if (pid == null || pid.length() == 0) {
                        config = configAdmin.createFactoryConfiguration(LogConfigManager.FACTORY_PID_CONFIGS);
                    } else {
                        config = configAdmin.getConfiguration(pid);
                    }
                    if (config != null) {
                        Dictionary<String, Object> dict = new Hashtable<String, Object>();
                        dict.put(LogConfigManager.LOG_LEVEL, logLevel.toLowerCase());
                        dict.put(LogConfigManager.LOG_LOGGERS, loggers);

View Full Code Here

                if (pid == null) {
                    throw new ConfigurationException(LogConfigManager.PID,
                            "PID has to be specified.");
                }
                // try to get the configadmin
                final ConfigurationAdmin configAdmin = (ConfigurationAdmin) this.bundleContext
                        .getService(sr);
                if (configAdmin != null) {
                    try {
                        Configuration config = configAdmin.getConfiguration(pid);
                        if (config != null) {
                            config.delete();
                        } else {
                            throw new ConfigurationException(LogConfigManager.PID,
                                    "No configuration for this PID:" + pid);

View Full Code Here

    }


    // ---------- internal -----------------------------------------------------


    private void verifyConfiguration(ServiceReference ref) {
        ConfigurationAdmin ca = (ConfigurationAdmin) bundleContext.getService(ref);
        if (ca == null) {
            log.error("verifyConfiguration: Failed to get Configuration Admin Service from Service Reference");
            return;
        }


        try {
            // find a configuration for theses properties...
            Configuration[] cfgs = ca.listConfigurations("("
                + ConfigurationAdmin.SERVICE_FACTORYPID + "="
                + SERVER_REPOSITORY_FACTORY_PID + ")");
            if (cfgs != null && cfgs.length > 0) {
                log.info(
                    "verifyConfiguration: {} Configurations available for {}, nothing to do",
                    new Object[] { new Integer(cfgs.length),
                        SERVER_REPOSITORY_FACTORY_PID });
                return;
            }


            // No config, create a default one.
            Hashtable<String, String> defaultConfig = new Hashtable<String, String>();
            final String overrideUrl = bundleContext.getProperty(RepositoryAccessor.REPOSITORY_URL_OVERRIDE_PROPERTY);
            if(overrideUrl != null && overrideUrl.length() > 0) {
                // Ignore other parameters if override URL (SLING-254) is set
                defaultConfig.put(RepositoryAccessor.REPOSITORY_URL_OVERRIDE_PROPERTY, overrideUrl);
                log.info(RepositoryAccessor.REPOSITORY_URL_OVERRIDE_PROPERTY + "=" + overrideUrl +
                    ", using it to create the default configuration");


            } else {
               initDefaultConfig(defaultConfig, bundleContext);
            }


            // create the factory and set the properties
            Configuration config = ca.createFactoryConfiguration(SERVER_REPOSITORY_FACTORY_PID);
            config.update(defaultConfig);


            log.info("verifyConfiguration: Created configuration {} for {}",
                config.getPid(), config.getFactoryPid());

View Full Code Here

            return;
        }
        
        out.println("# The CRANKSTART_CONFIG_ID property that we add to configs is meant to detect which factory configs have already been created");
        
        final ConfigurationAdmin ca = (ConfigurationAdmin)bundleContext.getService(ref);
        try {
            final Configuration [] allCfg = ca.listConfigurations(null);
            int count = 0;
            if(allCfg != null) {
                for(Configuration cfg : allCfg) {
                    count++;
                    if(cfg.getFactoryPid() != null && cfg.getFactoryPid().length() > 0) {

View Full Code Here




    @Test
    public void testEnableQueueProcessing() throws Exception {
        JobManager jobManager = mock(JobManager.class);
        ConfigurationAdmin configAdmin = mock(ConfigurationAdmin.class);
        Configuration config = mock(Configuration.class);
        when(configAdmin.createFactoryConfiguration(QueueConfiguration.class.getName(), null)).thenReturn(config);
        BundleContext context = mock(BundleContext.class);
        JobHandlingReplicationQueueProvider jobHandlingReplicationQueueProvider = new JobHandlingReplicationQueueProvider(
                jobManager, context);
        String agentName = "dummy-agent";
        ReplicationQueueProcessor queueProcessor = mock(ReplicationQueueProcessor.class);

View Full Code Here

    }


    @Test
    public void testDisableQueueProcessing() throws Exception {
        JobManager jobManager = mock(JobManager.class);
        ConfigurationAdmin configAdmin = mock(ConfigurationAdmin.class);
        Configuration config = mock(Configuration.class);
        when(configAdmin.createFactoryConfiguration(QueueConfiguration.class.getName(), null)).thenReturn(config);
        BundleContext context = mock(BundleContext.class);
        JobHandlingReplicationQueueProvider jobHandlingReplicationQueueProvider = new JobHandlingReplicationQueueProvider(
                jobManager,  context);
        String agentName = "dummy-agent";
        jobHandlingReplicationQueueProvider.disableQueueProcessing(agentName);

View Full Code Here

    }


    // ---------- internal -----------------------------------------------------


    private void verifyConfiguration(ServiceReference ref) {
        ConfigurationAdmin ca = (ConfigurationAdmin) bundleContext.getService(ref);
        if (ca == null) {
            log.error("verifyConfiguration: Failed to get Configuration Admin Service from Service Reference");
            return;
        }


        try {
            // find a configuration for theses properties...
            Configuration[] cfgs = ca.listConfigurations("("
                + ConfigurationAdmin.SERVICE_FACTORYPID + "="
                + this.getClientRepositoryFactoryPID() + ")");
            if (cfgs != null && cfgs.length > 0) {
                log.info(
                    "verifyConfiguration: {} Configurations available for {}, nothing to do",
                    new Object[] { new Integer(cfgs.length),
                        this.getClientRepositoryFactoryPID() });
                return;
            }


            // we have no configuration, create from default settings
            Hashtable<String, String> defaultConfig = new Hashtable<String, String>();
            final String overrideUrl = bundleContext.getProperty(RepositoryAccessor.REPOSITORY_URL_OVERRIDE_PROPERTY);
            if(overrideUrl != null && overrideUrl.length() > 0) {
                // Ignore other parameters if override URL (SLING-260) is set 
                defaultConfig.put(RepositoryAccessor.REPOSITORY_URL_OVERRIDE_PROPERTY, overrideUrl);
                log.debug(RepositoryAccessor.REPOSITORY_URL_OVERRIDE_PROPERTY + "=" + overrideUrl + 
                    ", using it to create the default configuration");
                
            } else {
               initDefaultConfig(defaultConfig); 
            }


            // create the factory and set the properties
            Configuration config = ca.createFactoryConfiguration(this.getClientRepositoryFactoryPID());
            config.update(defaultConfig);


            log.debug("verifyConfiguration: Created configuration {} for {}",
                config.getPid(), config.getFactoryPid());

View Full Code Here

        JSONObject jb = new JSONObject(MDC.getCopyOfContextMap());
        pw.print(jb.toString());
    }


    private void createTestConfig() throws IOException {
        ConfigurationAdmin ca = (ConfigurationAdmin) configAdminTracker.getService();
        Configuration cfg = ca.getConfiguration("org.apache.sling.extensions.mdc.internal.MDCInsertingFilter",null);


        Dictionary<String,Object> dict = new Hashtable<String, Object>();
        dict.put("headers",new String[]{"mdc-test-header"});
        dict.put("parameters",new String[]{"mdc-test-param"});
        dict.put("cookies",new String[]{"mdc-test-cookie"});

View Full Code Here

    @Rule
    public Service configAdminService = new Service(ConfigurationAdmin.class);
   
    @Test
    public void testConfigAdmin() throws Exception {
        ConfigurationAdmin configAdmin = configAdminService.getService(ConfigurationAdmin.class);
        assertNotNull(
                "Expecting ConfigurationAdmin to be injected by Sling test runner", 
                configAdmin);
        
        final String name = "TEST_" + getClass().getName() + System.currentTimeMillis();
        assertNotNull("Expecting config " + name + " to be created",
                configAdmin.getConfiguration(name));
    }

View Full Code Here

     * @throws Exception
     */
    @Override
    protected Dictionary getEditedProps() throws Exception {
        if(pid != null) {
            ConfigurationAdmin configurationAdmin = getConfigurationAdmin();
            if (configurationAdmin != null) {
                Configuration[] configs = configurationAdmin.listConfigurations("(service.pid=" + pid + ")");
                if (configs != null && configs.length > 0) {
                    Configuration configuration = configs[0];
                    if (configuration != null) {
                        return configuration.getProperties();
                    }

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.