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 $

  private void updateConfig() {
    try {
      ServiceReference sr = bc
          .getServiceReference(ConfigurationAdmin.class.getName());
      if (sr != null) {
        ConfigurationAdmin ca = (ConfigurationAdmin) bc.getService(sr);
        if (ca != null) {
          Configuration conf = ca.getConfiguration(pid);
          if (conf != null) {
            conf.update(configCollection);
          }
        }
        bc.ungetService(sr);

View Full Code Here

            "             will be listed." };


    public int cmdList(Dictionary opts, Reader in, PrintWriter out,
            Session session) {
        int retcode = 1; // 1 initially not set to 0 until end of try block
        ConfigurationAdmin srvCA = null;
        try {
            srvCA = getCA();


            String[] selection = (String[]) opts.get("selection");


            Configuration[] cs = null;
            if (selection == null) {
                cs = srvCA.listConfigurations(null);
            } else {
                cs = getConfigurations(session, srvCA, selection);
            }
            if (cs == null || cs.length == 0) {
                out.println("No configurations available");

View Full Code Here

            "             Use 'current' command to see the properties",
            "             of the currently edited configuration." };


    public int cmdShow(Dictionary opts, Reader in, PrintWriter out,
            Session session) {
        ConfigurationAdmin srvCA = null;


        try {
            srvCA = getCA();
            String[] selection = (String[]) opts.get("selection");
            Configuration[] cs = getConfigurations(session, srvCA, selection);

View Full Code Here

    public int cmdCreate(Dictionary opts, Reader in, PrintWriter out,
            Session session) {
        int retcode = 1; // 1 initially not set to 0 until end of try block
        setCurrent(session, null);
        setEditingDict(session, null);
        ConfigurationAdmin srvCA = null;
        try {
            srvCA = getCA();
            String pid = (String) opts.get("pid");
            boolean createFactoryConfiguration = opts.get("-f") != null;
            Configuration cfg = null;
            if (createFactoryConfiguration) {
                cfg = srvCA.createFactoryConfiguration(pid, null);
            } else {
                cfg = srvCA.getConfiguration(pid, null);
            }


            if (cfg == null) {
                throw new Exception("Failed creating configuration for " + pid);
            }

View Full Code Here

            "             configuration it will have to be refined." };


    public int cmdDelete(Dictionary opts, Reader in, PrintWriter out,
            Session session) {
        int retcode = 1; // 1 initially not set to 0 until end of try block
        ConfigurationAdmin srvCA = null;
        try {
            String selection = (String) opts.get("selection");


            srvCA = getCA();

View Full Code Here

            Session session) {
        int retcode = 1; // 1 initially not set to 0 until end of try block
        setEditingDict(session, null);
        setCurrent(session, null);


        ConfigurationAdmin srvCA = null;
        try {
            String selection = (String) opts.get("selection");


            srvCA = getCA();

View Full Code Here


    public int cmdSave(Dictionary opts, Reader in, PrintWriter out,
            Session session) {
        int retcode = 1; // 1 initially not set to 0 until end of try block
        boolean forceOptionNotSpecified = opts.get("-force") == null;
        ConfigurationAdmin srvCA = null;
        try {
            Configuration cfg = getCurrent(session);
            if (cfg == null) {
                throw new Exception("No configuration open currently");
            }

View Full Code Here

                throw new Exception("URL Object construction failed");
            }


            AccessController.doPrivileged(new PrivilegedExceptionAction() {
                public Object run() throws Exception {
                    ConfigurationAdmin configAdmin = null;
                    PushbackReader reader = null;
                    try {
                        configAdmin = getCA();


                        CMDataReader cmDataReader = new CMDataReader();
                        reader = new PushbackReader(new BufferedReader(
                                new InputStreamReader(url.openStream(),
                                        CMDataReader.ENCODING), 8192), 8);
                        Hashtable[] configs = cmDataReader.readCMDatas(reader);


                        for (int i = 0; i < configs.length; i++) {
                            String pid = (String) configs[i]
                                    .get(CMDataReader.SERVICE_PID);
                            String fpid = (String) configs[i]
                                    .get(CMDataReader.FACTORY_PID);
                            Configuration config;
                            if (fpid == null) {
                                config = configAdmin
                                        .getConfiguration(pid, null);
                            } else {
                                config = configAdmin
                                        .createFactoryConfiguration(fpid, null);
                            }
                            if (config.getBundleLocation() != null) {
                                config.setBundleLocation(null);
                            }

View Full Code Here

     * retcode; }
     */


    /** Helper method that get the CA service. */
    ConfigurationAdmin getCA() throws Exception {
        ConfigurationAdmin srvCA = null;
        if (refCA == null) {
            throw new Exception("CM service is not available");
        }
        try {
            srvCA = (ConfigurationAdmin) AccessController

View Full Code Here

        configReg = bc.registerService(ManagedServiceFactory.class.getName(),
                serverFactory, parameters);


        ServiceReference adminRef = null;
        try {
            ConfigurationAdmin admin = null;
            Configuration[] configs = null;
            try {
                adminRef = bc.getServiceReference(ConfigurationAdmin.class
                        .getName());


                // Potential start order problem!
                if (adminRef != null) {
                    admin = (ConfigurationAdmin) bc.getService(adminRef);
                    String filter = "(&(service.factoryPid=" + FACTORY_PID
                            + ")" + "(|(service.bundleLocation="
                            + bc.getBundle().getLocation() + ")"
                            + "(service.bundleLocation=NULL)"
                            + "(!(service.bundleLocation=*))))";
                    configs = admin.listConfigurations(filter);
                }
            } catch (Exception e) {
                if (log.doDebug())
                    log.debug("Exception when trying to get CM", e);
            }

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.