subsystem/subsystem-core/src/main/java/org/apache/aries/subsystem/core/internal/SubsystemResourceInstaller.java

/*
 * Licensed 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.aries.subsystem.core.internal;

import java.io.InputStream;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;

import org.apache.aries.util.filesystem.FileSystem;
import org.osgi.resource.Resource;
import org.osgi.service.coordinator.Coordination;
import org.osgi.service.coordinator.Participant;
import org.osgi.service.subsystem.Subsystem.State;

public class SubsystemResourceInstaller extends ResourceInstaller {
	public SubsystemResourceInstaller(Coordination coordination, Resource resource, BasicSubsystem subsystem) {
		super(coordination, resource, subsystem);
	}

	public Resource install() throws Exception {
		if (resource instanceof BasicSubsystem)
			return installAriesSubsystem((BasicSubsystem)resource);
		else if (resource instanceof RawSubsystemResource)
			return installRawSubsystemResource((RawSubsystemResource)resource);
		else if (resource instanceof SubsystemResource)
			return installSubsystemResource((SubsystemResource)resource);
		else {
			return installRepositoryContent(resource);
		}
	}

	private void addChild(final BasicSubsystem child) {
		// provisionTo will be null if the resource is an already installed
		// dependency.
		if (provisionTo == null)
			return;
		// Don't let a resource become a child of itself.
		if (resource.equals(provisionTo))
			return;
		Activator.getInstance().getSubsystems().addChild(provisionTo, child, !isDependency());
		coordination.addParticipant(new Participant() {
			@Override
			public void ended(Coordination arg0) throws Exception {
				// Nothing
			}

			@Override
			public void failed(Coordination arg0) throws Exception {
				Activator.getInstance().getSubsystems().removeChild(provisionTo, child);
			}
		});
	}

	private void addSubsystem(final BasicSubsystem subsystem) {
		Activator.getInstance().getSubsystems().addSubsystem(subsystem);
		coordination.addParticipant(new Participant() {
			@Override
			public void ended(Coordination arg0) throws Exception {
				// Nothing
			}

			@Override
			public void failed(Coordination arg0) throws Exception {
				Activator.getInstance().getSubsystems().removeSubsystem(subsystem);
			}
		});
	}

	private BasicSubsystem installAriesSubsystem(BasicSubsystem subsystem) throws Exception {
		addChild(subsystem);
		addReference(subsystem);
		addConstituent(subsystem);
		addSubsystem(subsystem);
		installRegionContextBundle(subsystem);
		// This will emit the initial service event for INSTALLING subsystems.
		// The first event for RESOLVED (i.e. persisted) subsystems is emitted later.
		if (State.INSTALLING.equals(subsystem.getState()))
			Activator.getInstance().getSubsystemServiceRegistrar().register(subsystem, this.subsystem);
		Comparator<Resource> comparator = new InstallResourceComparator();
		// Install dependencies first...
		List<Resource> dependencies = new ArrayList<Resource>(subsystem.getResource().getInstallableDependencies());
		Collections.sort(dependencies, comparator);
		for (Resource dependency : dependencies)
			ResourceInstaller.newInstance(coordination, dependency, subsystem).install();
		for (Resource dependency : subsystem.getResource().getSharedDependencies()) {
			// TODO This needs some more thought. The following check
			// protects against a child subsystem that has its parent as a
			// dependency. Are there other places of concern as well? Is it
			// only the current parent that is of concern or should all
			// parents be checked?
			if (!dependency.equals(this.subsystem))
				ResourceInstaller.newInstance(coordination, dependency, subsystem).install();
		}
		// ...followed by content.
		if (State.INSTALLING.equals(subsystem.getState())) {
			List<Resource> installableContent = new ArrayList<Resource>(subsystem.getResource().getInstallableContent());
			Collections.sort(installableContent, comparator);
			for (Resource content : installableContent)
				ResourceInstaller.newInstance(coordination, content, subsystem).install();
		}
		// Simulate installation of shared content so that necessary relationships are established.
		for (Resource content : subsystem.getResource().getSharedContent())
			ResourceInstaller.newInstance(coordination, content, subsystem).install();
		// Only brand new subsystems should have acquired the INSTALLING state,
		// in which case an INSTALLED event must be propagated.
		if (State.INSTALLING.equals(subsystem.getState()))
			subsystem.setState(State.INSTALLED);
		else
			// This is a persisted subsystem in the RESOLVED state. Emit the first service event.
			Activator.getInstance().getSubsystemServiceRegistrar().register(subsystem, this.subsystem);
		return subsystem;
	}

	private BasicSubsystem installRawSubsystemResource(RawSubsystemResource resource) throws Exception {
		SubsystemResource subsystemResource = new SubsystemResource(resource, provisionTo);
		return installSubsystemResource(subsystemResource);
	}

	private void installRegionContextBundle(final BasicSubsystem subsystem) throws Exception {
		if (!subsystem.isScoped())
			return;
		RegionContextBundleHelper.installRegionContextBundle(subsystem, coordination);
		coordination.addParticipant(new Participant() {
			@Override
			public void ended(Coordination coordination) throws Exception {
				// Nothing
			}

			@Override
			public void failed(Coordination coordination) throws Exception {
				RegionContextBundleHelper.uninstallRegionContextBundle(subsystem);
			}
		});
	}

	private BasicSubsystem installRepositoryContent(Resource resource) throws Exception {
		Method method = resource.getClass().getMethod("getContent");
		InputStream is = (InputStream)method.invoke(resource);
		RawSubsystemResource rawSubsystemResource = new RawSubsystemResource(getLocation(), FileSystem.getFSRoot(is), subsystem);
		return installRawSubsystemResource(rawSubsystemResource);
	}

	private BasicSubsystem installSubsystemResource(SubsystemResource resource) throws Exception {
		BasicSubsystem subsystem = new BasicSubsystem(resource);
		installAriesSubsystem(subsystem);
		return subsystem;
	}
}