org.apache.felix.webconsole.internal.AbstractConfigurationPrinter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.apache.felix.webconsole Show documentation

Web Based Management Console for OSGi Frameworks. See http://felix.apache.org/site/apache-felix-web-console.html for more information on this bundle.

There is a newer version: 5.0.8

Show newest version

/*
 * 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;


import java.util.Dictionary;
import java.util.Hashtable;

import org.apache.felix.inventory.InventoryPrinter;
import org.osgi.framework.BundleContext;
import org.osgi.framework.ServiceRegistration;

/**
 * AbstractConfigurationPrinter is an utility class, that provides a basic implementation
 * of {@link InventoryPrinter} and {@link OsgiManagerPlugin} interfaces.
 */
public abstract class AbstractConfigurationPrinter implements InventoryPrinter, OsgiManagerPlugin {

    private volatile BundleContext bundleContext;

    private volatile ServiceRegistration registration;

    /**
     * @see org.apache.felix.webconsole.internal.OsgiManagerPlugin#activate(org.osgi.framework.BundleContext)
     */
    public void activate( BundleContext bundleContext ) {
        this.bundleContext = bundleContext;
        final Dictionary props = new Hashtable<>();
        props.put(InventoryPrinter.TITLE, this.getTitle());
        props.put(InventoryPrinter.NAME, this.getTitle());

        this.registration = bundleContext.registerService( InventoryPrinter.class, this, props );
    }

    /**
     * @see org.apache.felix.webconsole.internal.OsgiManagerPlugin#deactivate()
     */
    public void deactivate() {
        if ( this.registration != null ) {
            try {
                this.registration.unregister();
            } catch ( final IllegalStateException ise ) {
                // ignore, bundle context already invalid
            }
            this.registration = null;
        }
        this.bundleContext = null;
    }

    /**
     * Returns the BundleContext with which this plugin has been
     * activated. If the plugin has not be activated by calling the
     * {@link #activate(BundleContext)} method, this method returns
     * null.
     *
     * @return the bundle context or null if the bundle is not activated.
     */
    protected BundleContext getBundleContext() {
        return bundleContext;
    }

    /**
     * Get the title
     * @return The title
     */
    protected abstract String getTitle();
}