/*******************************************************************************
* Copyright (c) 2003, 2007 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.osgi.internal.resolver;
import java.io.*;
import java.util.*;
import org.eclipse.osgi.framework.internal.core.Constants;
import org.eclipse.osgi.internal.module.ResolverImpl;
import org.eclipse.osgi.service.resolver.*;
import org.eclipse.osgi.storagemanager.StorageManager;
import org.eclipse.osgi.util.ManifestElement;
import org.osgi.framework.*;
public class StateObjectFactoryImpl implements StateObjectFactory {
public BundleDescription createBundleDescription(Dictionary manifest, String location, long id) throws BundleException {
return createBundleDescription(null, manifest, location, id);
}
public BundleDescription createBundleDescription(State state, Dictionary manifest, String location, long id) throws BundleException {
BundleDescriptionImpl result = (BundleDescriptionImpl) StateBuilder.createBundleDescription((StateImpl) state, manifest, location);
result.setBundleId(id);
return result;
}
public BundleDescription createBundleDescription(long id, String symbolicName, Version version, String location, BundleSpecification[] required, HostSpecification host, ImportPackageSpecification[] imports, ExportPackageDescription[] exports, String[] providedPackages, boolean singleton) {
return createBundleDescription(id, symbolicName, version, location, required, host, imports, exports, providedPackages, singleton, true, true, null, null, null, null);
}
public BundleDescription createBundleDescription(long id, String symbolicName, Version version, String location, BundleSpecification[] required, HostSpecification host, ImportPackageSpecification[] imports, ExportPackageDescription[] exports, String[] providedPackages, boolean singleton, boolean attachFragments, boolean dynamicFragments, String platformFilter, String executionEnvironment, GenericSpecification[] genericRequires, GenericDescription[] genericCapabilities) {
// bug 154137 we need to parse the executionEnvironment param; no need to check for null, ManifestElement does that for us.
return createBundleDescription(id, symbolicName, version, location, required, host, imports, exports, singleton, attachFragments, dynamicFragments, platformFilter, ManifestElement.getArrayFromList(executionEnvironment), genericRequires, genericCapabilities);
}
public BundleDescription createBundleDescription(long id, String symbolicName, Version version, String location, BundleSpecification[] required, HostSpecification host, ImportPackageSpecification[] imports, ExportPackageDescription[] exports, boolean singleton, boolean attachFragments, boolean dynamicFragments, String platformFilter, String[] executionEnvironments, GenericSpecification[] genericRequires, GenericDescription[] genericCapabilities) {
BundleDescriptionImpl bundle = new BundleDescriptionImpl();
bundle.setBundleId(id);
bundle.setSymbolicName(symbolicName);
bundle.setVersion(version);
bundle.setLocation(location);
bundle.setRequiredBundles(required);
bundle.setHost(host);
bundle.setImportPackages(imports);
bundle.setExportPackages(exports);
bundle.setStateBit(BundleDescriptionImpl.SINGLETON, singleton);
bundle.setStateBit(BundleDescriptionImpl.ATTACH_FRAGMENTS, attachFragments);
bundle.setStateBit(BundleDescriptionImpl.DYNAMIC_FRAGMENTS, dynamicFragments);
bundle.setPlatformFilter(platformFilter);
bundle.setExecutionEnvironments(executionEnvironments);
bundle.setGenericRequires(genericRequires);
bundle.setGenericCapabilities(genericCapabilities);
return bundle;
}
public BundleDescription createBundleDescription(BundleDescription original) {
BundleDescriptionImpl bundle = new BundleDescriptionImpl();
bundle.setBundleId(original.getBundleId());
bundle.setSymbolicName(original.getSymbolicName());
bundle.setVersion(original.getVersion());
bundle.setLocation(original.getLocation());
BundleSpecification[] originalRequired = original.getRequiredBundles();
BundleSpecification[] newRequired = new BundleSpecification[originalRequired.length];
for (int i = 0; i < newRequired.length; i++)
newRequired[i] = createBundleSpecification(originalRequired[i]);
bundle.setRequiredBundles(newRequired);
ExportPackageDescription[] originalExports = original.getExportPackages();
ExportPackageDescription[] newExports = new ExportPackageDescription[originalExports.length];
for (int i = 0; i < newExports.length; i++)
newExports[i] = createExportPackageDescription(originalExports[i]);
bundle.setExportPackages(newExports);
ImportPackageSpecification[] originalImports = original.getImportPackages();
ImportPackageSpecification[] newImports = new ImportPackageSpecification[originalImports.length];
for (int i = 0; i < newImports.length; i++)
newImports[i] = createImportPackageSpecification(originalImports[i]);
bundle.setImportPackages(newImports);
if (original.getHost() != null)
bundle.setHost(createHostSpecification(original.getHost()));
bundle.setStateBit(BundleDescriptionImpl.SINGLETON, original.isSingleton());
bundle.setStateBit(BundleDescriptionImpl.ATTACH_FRAGMENTS, original.attachFragments());
bundle.setStateBit(BundleDescriptionImpl.DYNAMIC_FRAGMENTS, original.dynamicFragments());
bundle.setStateBit(BundleDescriptionImpl.HAS_DYNAMICIMPORT, original.hasDynamicImports());
bundle.setPlatformFilter(original.getPlatformFilter());
bundle.setExecutionEnvironments(original.getExecutionEnvironments());
bundle.setGenericCapabilities(createGenericCapabilities(original.getGenericCapabilities()));
bundle.setGenericRequires(createGenericRequires(original.getGenericRequires()));
return bundle;
}
private GenericDescription[] createGenericCapabilities(GenericDescription[] genericCapabilities) {
if (genericCapabilities == null || genericCapabilities.length == 0)
return null;
GenericDescription[] result = new GenericDescription[genericCapabilities.length];
for (int i = 0; i < genericCapabilities.length; i++) {
GenericDescriptionImpl cap = new GenericDescriptionImpl();
cap.setName(genericCapabilities[i].getName());
cap.setVersion(genericCapabilities[i].getVersion());
cap.setAttributes(genericCapabilities[i].getAttributes());
result[i] = cap;
}
return result;
}
private GenericSpecification[] createGenericRequires(GenericSpecification[] genericRequires) {
if (genericRequires == null || genericRequires.length == 0)
return null;
GenericSpecification[] result = new GenericSpecification[genericRequires.length];
for (int i = 0; i < genericRequires.length; i++) {
GenericSpecificationImpl req = new GenericSpecificationImpl();
req.setName(genericRequires[i].getName());
try {
req.setMatchingFilter(genericRequires[i].getMatchingFilter());
} catch (InvalidSyntaxException e) {
// do nothing; this filter should aready have been tested
}
result[i] = req;
}
return result;
}
public BundleSpecification createBundleSpecification(String requiredSymbolicName, VersionRange requiredVersionRange, boolean export, boolean optional) {
BundleSpecificationImpl bundleSpec = new BundleSpecificationImpl();
bundleSpec.setName(requiredSymbolicName);
bundleSpec.setVersionRange(requiredVersionRange);
bundleSpec.setExported(export);
bundleSpec.setOptional(optional);
return bundleSpec;
}
public BundleSpecification createBundleSpecification(BundleSpecification original) {
BundleSpecificationImpl bundleSpec = new BundleSpecificationImpl();
bundleSpec.setName(original.getName());
bundleSpec.setVersionRange(original.getVersionRange());
bundleSpec.setExported(original.isExported());
bundleSpec.setOptional(original.isOptional());
return bundleSpec;
}
public HostSpecification createHostSpecification(String hostSymbolicName, VersionRange versionRange) {
HostSpecificationImpl hostSpec = new HostSpecificationImpl();
hostSpec.setName(hostSymbolicName);
hostSpec.setVersionRange(versionRange);
return hostSpec;
}
public HostSpecification createHostSpecification(HostSpecification original) {
HostSpecificationImpl hostSpec = new HostSpecificationImpl();
hostSpec.setName(original.getName());
hostSpec.setVersionRange(original.getVersionRange());
return hostSpec;
}
public ImportPackageSpecification createImportPackageSpecification(String packageName, VersionRange versionRange, String bundleSymbolicName, VersionRange bundleVersionRange, Map directives, Map attributes, BundleDescription importer) {
ImportPackageSpecificationImpl packageSpec = new ImportPackageSpecificationImpl();
packageSpec.setName(packageName);
packageSpec.setVersionRange(versionRange);
packageSpec.setBundleSymbolicName(bundleSymbolicName);
packageSpec.setBundleVersionRange(bundleVersionRange);
packageSpec.setDirectives(directives);
packageSpec.setAttributes(attributes);
packageSpec.setBundle(importer);
return packageSpec;
}
public ImportPackageSpecification createImportPackageSpecification(ImportPackageSpecification original) {
ImportPackageSpecificationImpl packageSpec = new ImportPackageSpecificationImpl();
packageSpec.setName(original.getName());
packageSpec.setVersionRange(original.getVersionRange());
packageSpec.setBundleSymbolicName(original.getBundleSymbolicName());
packageSpec.setBundleVersionRange(original.getBundleVersionRange());
packageSpec.setDirectives(original.getDirectives());
packageSpec.setAttributes(original.getAttributes());
return packageSpec;
}
public ExportPackageDescription createExportPackageDescription(ExportPackageDescription original) {
return createExportPackageDescription(original.getName(), original.getVersion(), original.getDirectives(), original.getAttributes(), original.isRoot(), null);
}
public ExportPackageDescription createExportPackageDescription(String packageName, Version version, Map directives, Map attributes, boolean root, BundleDescription exporter) {
ExportPackageDescriptionImpl exportPackage = new ExportPackageDescriptionImpl();
exportPackage.setName(packageName);
exportPackage.setVersion(version);
exportPackage.setDirectives(directives);
exportPackage.setAttributes(attributes);
exportPackage.setRoot(root);
exportPackage.setExporter(exporter);
return exportPackage;
}
public GenericDescription createGenericDescription(String name, String type, Version version, Map attributes) {
GenericDescriptionImpl result = new GenericDescriptionImpl();
result.setName(name);
result.setType(type);
result.setVersion(version);
Object versionObj = attributes == null ? null : attributes.remove(Constants.VERSION_ATTRIBUTE);
if (versionObj instanceof Version) // this is just incase someone uses version:version as a key
result.setVersion((Version) versionObj);
Dictionary attrs = new Hashtable();
if (attributes != null)
for (Iterator keys = attributes.keySet().iterator(); keys.hasNext();) {
Object key = keys.next();
attrs.put(key, attributes.get(key));
}
result.setAttributes(attrs);
return result;
}
public GenericSpecification createGenericSpecification(String name, String type, String matchingFilter, boolean optional, boolean multiple) throws InvalidSyntaxException {
GenericSpecificationImpl result = new GenericSpecificationImpl();
result.setName(name);
result.setType(type);
result.setMatchingFilter(matchingFilter);
int resolution = 0;
if (optional)
resolution |= GenericSpecification.RESOLUTION_OPTIONAL;
if (multiple)
resolution |= GenericSpecification.RESOLUTION_MULTIPLE;
result.setResolution(resolution);
return result;
}
public SystemState createSystemState() {
SystemState state = new SystemState();
state.setFactory(this);
return state;
}
public State createState() {
return internalCreateState();
}
public State createState(boolean createResolver) {
State result = internalCreateState();
if (createResolver)
result.setResolver(new ResolverImpl(null, false));
return result;
}
public State createState(State original) {
StateImpl newState = internalCreateState();
newState.setTimeStamp(original.getTimeStamp());
BundleDescription[] bundles = original.getBundles();
for (int i = 0; i < bundles.length; i++)
newState.basicAddBundle(createBundleDescription(bundles[i]));
newState.setResolved(false);
newState.setPlatformProperties(original.getPlatformProperties());
return newState;
}
private StateImpl internalCreateState() {
StateImpl state = new UserState();
state.setFactory(this);
return state;
}
public SystemState readSystemState(File stateFile, File lazyFile, boolean lazyLoad, long expectedTimeStamp) throws IOException {
StateReader reader = new StateReader(stateFile, lazyFile, lazyLoad);
SystemState restoredState = new SystemState();
restoredState.setReader(reader);
restoredState.setFactory(this);
if (!reader.loadState(restoredState, expectedTimeStamp))
return null;
return restoredState;
}
public State readState(InputStream stream) throws IOException {
return internalReadStateDeprecated(internalCreateState(), new DataInputStream(stream), -1);
}
public State readState(DataInputStream stream) throws IOException {
return internalReadStateDeprecated(internalCreateState(), stream, -1);
}
public State readState(File stateDirectory) throws IOException {
return internalReadState(internalCreateState(), stateDirectory, -1);
}
private State internalReadStateDeprecated(StateImpl toRestore, DataInputStream stream, long expectedTimestamp) throws IOException {
StateReader reader = new StateReader();
if (!reader.loadStateDeprecated(toRestore, stream, expectedTimestamp))
return null;
return toRestore;
}
private State internalReadState(StateImpl toRestore, File stateDirectory, long expectedTimestamp) throws IOException {
File stateFile = new File(stateDirectory, StateReader.STATE_FILE);
File lazyFile = new File(stateDirectory, StateReader.LAZY_FILE);
if (!stateFile.exists() || !lazyFile.exists()) {
StorageManager storageManager = new StorageManager(stateDirectory, "none", true); //$NON-NLS-1$
try {
// if the directory is pointing at the configuration directory then the base files will not exist
storageManager.open(true);
// try using the storage manager to find the managed state files (bug 143255)
File managedState = storageManager.lookup(StateReader.STATE_FILE, false);
File managedLazy = storageManager.lookup(StateReader.LAZY_FILE, false);
if (managedState != null && managedLazy != null) {
stateFile = managedState;
lazyFile = managedLazy;
}
} finally {
storageManager.close();
}
}
StateReader reader = new StateReader(stateFile, lazyFile, false);
if (!reader.loadState(toRestore, expectedTimestamp))
return null;
return toRestore;
}
public void writeState(State state, DataOutputStream stream) throws IOException {
internalWriteStateDeprecated(state, stream);
}
public void writeState(State state, File stateDirectory) throws IOException {
if (stateDirectory == null)
throw new IOException();
StateWriter writer = new StateWriter();
File stateFile = new File(stateDirectory, StateReader.STATE_FILE);
File lazyFile = new File(stateDirectory, StateReader.LAZY_FILE);
writer.saveState((StateImpl) state, stateFile, lazyFile);
}
public void writeState(State state, OutputStream stream) throws IOException {
internalWriteStateDeprecated(state, new DataOutputStream(stream));
}
public void writeState(State state, File stateFile, File lazyFile) throws IOException {
StateWriter writer = new StateWriter();
writer.saveState((StateImpl) state, stateFile, lazyFile);
}
public void internalWriteStateDeprecated(State state, DataOutputStream stream) throws IOException {
if (state.getFactory() != this)
throw new IllegalArgumentException();
StateWriter writer = new StateWriter();
writer.saveStateDeprecated((StateImpl) state, stream);
}
}