PreferencesConfigurationPrinter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.felix.webconsole.internal.compendium;

import java.io.PrintWriter;

import org.apache.felix.webconsole.internal.AbstractConfigurationPrinter;
import org.apache.felix.webconsole.internal.misc.ConfigurationRender;
import org.osgi.framework.ServiceReference;
import org.osgi.service.prefs.BackingStoreException;
import org.osgi.service.prefs.Preferences;
import org.osgi.service.prefs.PreferencesService;

/**
 * PreferencesConfigurationPrinter uses the {@link Preferences} service
 * to print the store bundle preferences.
 */
public class PreferencesConfigurationPrinter extends AbstractConfigurationPrinter
{

    private static final String TITLE = "Preferences";

    /**
     * @see org.apache.felix.webconsole.ConfigurationPrinter#getTitle()
     */
    public String getTitle()
    {
        return TITLE;
    }

    /**
     * @see org.apache.felix.webconsole.ConfigurationPrinter#printConfiguration(java.io.PrintWriter)
     */
    public void printConfiguration(PrintWriter printWriter)
    {
        ServiceReference sr = getBundleContext().getServiceReference(
            PreferencesService.class.getName());
        if (sr == null)
        {
            printWriter.println("Status: Preferences Service not available");
        }
        else
        {
            PreferencesService ps = (PreferencesService) getBundleContext().getService(sr);
            try
            {
                printPreferences(printWriter, ps.getSystemPreferences());

                String[] users = ps.getUsers();
                for (int i = 0; users != null && i < users.length; i++)
                {
                    printWriter.println("*** User Preferences " + users[i] + ":");
                    printPreferences(printWriter, ps.getUserPreferences(users[i]));
                }
            }
            catch (BackingStoreException bse)
            {
                // todo or not :-)
            }
            finally
            {
                getBundleContext().ungetService(sr);
            }
        }
    }

    private static final void printPreferences(PrintWriter pw, Preferences prefs)
        throws BackingStoreException
    {

        final String[] children = prefs.childrenNames();
        final String[] keys = prefs.keys();

        if (children.length == 0 && keys.length == 0)
        {
            pw.println("Status: No Preferences available");
        }
        else
        {
            for (int i = 0; i < children.length; i++)
            {
                printPreferences(pw, prefs.node(children[i]));
            }

            for (int i = 0; i < keys.length; i++)
            {
                ConfigurationRender.infoLine(pw, null, prefs.absolutePath() + "/"
                    + keys[i], prefs.get(keys[i], null));
            }
        }

        pw.println();
    }
}