SystemServicesIntegration.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2010, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.as.osgi.service;

import static org.jboss.as.network.SocketBinding.JBOSS_BINDING_NAME;
import static org.jboss.as.server.Services.JBOSS_SERVER_CONTROLLER;

import java.net.InetSocketAddress;
import java.net.URL;
import java.util.Dictionary;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.ThreadFactory;

import org.jboss.as.controller.ModelController;
import org.jboss.as.controller.client.ModelControllerClient;
import org.jboss.as.network.SocketBinding;
import org.jboss.as.osgi.OSGiConstants;
import org.jboss.as.osgi.SubsystemExtension;
import org.jboss.as.osgi.management.OSGiRuntimeResource;
import org.jboss.msc.service.AbstractService;
import org.jboss.msc.service.ServiceBuilder;
import org.jboss.msc.service.ServiceContainer;
import org.jboss.msc.service.ServiceName;
import org.jboss.msc.service.ServiceTarget;
import org.jboss.msc.service.StartContext;
import org.jboss.msc.service.StartException;
import org.jboss.msc.service.StopContext;
import org.jboss.msc.value.InjectedValue;
import org.jboss.osgi.framework.Services;
import org.jboss.osgi.framework.spi.BundleManager;
import org.jboss.osgi.framework.spi.IntegrationServices;
import org.jboss.osgi.framework.spi.SystemServices;
import org.jboss.osgi.framework.spi.SystemServicesPlugin;
import org.jboss.osgi.provision.AbstractResourceProvisioner;
import org.jboss.osgi.provision.XResourceProvisioner;
import org.jboss.osgi.repository.ResourceInstaller;
import org.jboss.osgi.repository.XRepository;
import org.jboss.osgi.resolver.XResolver;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.service.repository.Repository;
import org.osgi.util.xml.XMLParserActivator;

/**
 * An {@link org.jboss.osgi.framework.spi.IntegrationService} that provides system services on framework startup
 *
 * @author Thomas.Diesler@jboss.com
 * @since 11-Sep-2010
 */
final class SystemServicesIntegration extends SystemServicesPlugin {

    private final InjectedValue<ModelController> injectedModelController = new InjectedValue<ModelController>();
    private final InjectedValue<BundleManager> injectedBundleManager = new InjectedValue<BundleManager>();
    private final InjectedValue<BundleContext> injectedBundleContext = new InjectedValue<BundleContext>();
    private final InjectedValue<XRepository> injectedRepository = new InjectedValue<XRepository>();
    private final InjectedValue<XResolver> injectedResolver = new InjectedValue<XResolver>();
    private final InjectedValue<ResourceInstaller> injectedResourceInstaller = new InjectedValue<ResourceInstaller>();
    private final List<SubsystemExtension> extensions;
    private final OSGiRuntimeResource resource;
    private ServiceContainer serviceContainer;
    private ExecutorService controllerThreadExecutor;

    SystemServicesIntegration(OSGiRuntimeResource resource, List<SubsystemExtension> extensions) {
        this.extensions = extensions;
        this.resource = resource;
    }

    @Override
    protected void addServiceDependencies(ServiceBuilder<SystemServices> builder) {
        super.addServiceDependencies(builder);
        builder.addDependency(JBOSS_SERVER_CONTROLLER, ModelController.class, injectedModelController);
        builder.addDependency(OSGiConstants.REPOSITORY_SERVICE_NAME, XRepository.class, injectedRepository);
        builder.addDependency(ResourceInstallerService.SERVICE_NAME, ResourceInstaller.class, injectedResourceInstaller);
        builder.addDependency(Services.BUNDLE_MANAGER, BundleManager.class, injectedBundleManager);
        builder.addDependency(Services.FRAMEWORK_CREATE, BundleContext.class, injectedBundleContext);
        builder.addDependency(Services.RESOLVER, XResolver.class, injectedResolver);
        // Subsystem extension dependencies
        for (SubsystemExtension extension : extensions) {
            extension.configureServiceDependencies(getServiceName(), builder);
        }
    }

    @Override
    public void start(StartContext startContext) throws StartException {
        serviceContainer = startContext.getController().getServiceContainer();
        super.start(startContext);

        // Perform subsystem extension start
        BundleContext syscontext = injectedBundleContext.getValue();
        for (SubsystemExtension extension : extensions) {
            extension.startSystemServices(startContext, syscontext);
        }
    }

    @Override
    public void stop(StopContext context) {

        // Perform subsystem extension stop
        BundleContext syscontext = injectedBundleContext.getValue();
        for (SubsystemExtension extension : extensions) {
            extension.stopSystemServices(context, syscontext);
        }

        // Unregister the system services
        super.stop(context);
    }

    @Override
    protected SystemServices createServiceValue(StartContext startContext) throws StartException {
        final SystemServices delegate = super.createServiceValue(startContext);
        return new SystemServices() {

            @Override
            public void registerServices(BundleContext syscontext) {
                // Call the default implementation
                delegate.registerServices(syscontext);

                // Inject the system bundle context into the runtime resource
                BundleManager bundleManager = injectedBundleManager.getValue();
                resource.getInjectedBundleManager().inject(bundleManager);

                registerJAXPServices(syscontext);
                registerServiceContainer(syscontext);
                registerSocketBindingServices(syscontext);
                registerRepositoryServices(syscontext);
                registerProvisionerServices(syscontext);
                registerModelControllerServices(syscontext);
            }

            @Override
            public void unregisterServices() {
                resource.getInjectedBundleManager().uninject();
                controllerThreadExecutor.shutdown();
                delegate.unregisterServices();
            }
        };
    }

    private void registerJAXPServices(BundleContext syscontext) {
        try {
            final ClassLoader resloader = getClass().getClassLoader();
            XMLParserActivator activator = new XMLParserActivator() {
                @Override
                protected URL getResourceURL(Bundle parserBundle, String resname) {
                    return resloader.getResource(resname);
                }
            };
            activator.start(syscontext);
        } catch (Exception e) {
            throw new IllegalStateException(e);
        }
    }

    private void registerServiceContainer(final BundleContext syscontext) {
        syscontext.registerService(ServiceContainer.class, serviceContainer, null);
    }

    private void registerRepositoryServices(BundleContext syscontext) {
        XRepository repository = injectedRepository.getValue();
        String[] classes = new String[] { XRepository.class.getName(), Repository.class.getName() };
        syscontext.registerService(classes, repository, null);
        ResourceInstaller installer = injectedResourceInstaller.getValue();
        syscontext.registerService(ResourceInstaller.class, installer, null);
    }

    private void registerProvisionerServices(final BundleContext syscontext) {
        XResolver resolver = injectedResolver.getValue();
        XRepository repository = injectedRepository.getValue();
        XResourceProvisioner provisioner = new AbstractResourceProvisioner(resolver, repository);
        syscontext.registerService(XResourceProvisioner.class, provisioner, null);
    }

    private void registerModelControllerServices(final BundleContext syscontext) {
        // The ExecutorService that is used by the ModelControllerClient service
        controllerThreadExecutor = Executors.newSingleThreadExecutor(new ThreadFactory() {
            @Override
            public Thread newThread(Runnable run) {
                Thread thread = new Thread(run);
                thread.setName("OSGi ModelControllerClient Thread");
                thread.setDaemon(true);
                return thread;
            }
        });
        // Register the {@link ModelControllerClient} service
        ModelController modelController = injectedModelController.getValue();
        ModelControllerClient client = modelController.createClient(controllerThreadExecutor);
        syscontext.registerService(ModelControllerClient.class, client, null);
    }

    private void registerSocketBindingServices(final BundleContext syscontext) {
        BundleManager bundleManager = injectedBundleManager.getValue();
        String bindingNames = syscontext.getProperty(FrameworkBootstrapService.MAPPED_OSGI_SOCKET_BINDINGS);
        if (bindingNames != null) {
            final Set<ServiceName> socketBindingNames = new HashSet<ServiceName>();
            for (String suffix : bindingNames.split(",")) {
                socketBindingNames.add(JBOSS_BINDING_NAME.append(suffix));
            }
            ServiceTarget serviceTarget = bundleManager.getServiceTarget();
            ServiceName serviceName = IntegrationServices.SYSTEM_SERVICES_PLUGIN.append("BINDINGS");
            ServiceBuilder<Void> builder = serviceTarget.addService(serviceName, new AbstractService<Void>() {
                @Override
                public void start(StartContext context) throws StartException {
                    for (ServiceName serviceName : socketBindingNames) {
                        SocketBinding binding = (SocketBinding) serviceContainer.getRequiredService(serviceName).getValue();
                        Dictionary<String, String> props = new Hashtable<String, String>();
                        props.put("socketBinding", serviceName.getSimpleName());
                        InetSocketAddress value = binding.getSocketAddress();
                        syscontext.registerService(InetSocketAddress.class, value, props);
                    }
                }
            });
            ServiceName[] serviceNameArray = socketBindingNames.toArray(new ServiceName[socketBindingNames.size()]);
            builder.addDependencies(serviceNameArray);
            builder.install();
        }
    }
}