/*
- * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
+ * Copyright (C) 2007-2012 Mathieu Baudier
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.argeo.slc.osgi;
-import org.argeo.slc.build.BasicNameVersion;
+import org.argeo.slc.BasicNameVersion;
+import org.argeo.slc.NameVersion;
import org.argeo.slc.build.Distribution;
-import org.argeo.slc.build.NameVersion;
import org.argeo.slc.core.build.ResourceDistribution;
import org.argeo.slc.deploy.DeploymentData;
import org.argeo.slc.deploy.Module;
+import org.argeo.slc.deploy.ModuleDescriptor;
import org.argeo.slc.deploy.TargetData;
import org.argeo.slc.process.RealizedFlow;
import org.osgi.framework.Bundle;
import org.osgi.framework.Constants;
+import org.springframework.core.io.Resource;
+/** A deployed OSGi bundle. */
public class OsgiBundle extends BasicNameVersion implements Module {
+ private static final long serialVersionUID = 35073826504550477L;
+
private ResourceDistribution distribution;
private Long internalBundleId;
- private String label;
+ private String title;
private String description;
public OsgiBundle() {
internalBundleId = bundle.getBundleId();
}
+ /**
+ * Initialize from a {@link RealizedFlow}.
+ *
+ * @deprecated introduce an unnecessary dependency. TODO: create a separate
+ * helper.
+ */
+ public OsgiBundle(RealizedFlow realizedFlow) {
+ super(realizedFlow.getModuleName(), realizedFlow.getModuleVersion());
+ }
+
+ /** Utility to avoid NPE. */
private static String getVersionSafe(Bundle bundle) {
Object versionObj = bundle.getHeaders().get(Constants.BUNDLE_VERSION);
if (versionObj != null)
return null;
}
- public OsgiBundle(RealizedFlow realizedFlow) {
- super(realizedFlow.getModuleName(), realizedFlow.getModuleVersion());
- }
-
+ /** Unique deployed system id. TODO: use internal bundle id when available? */
public String getDeployedSystemId() {
return getName() + ":" + getVersion();
}
+ /**
+ * OSGi bundle are self-contained and do not require additional deployment
+ * data.
+ *
+ * @return always null
+ */
public DeploymentData getDeploymentData() {
- throw new UnsupportedOperationException();
+ return null;
}
+ /** The related distribution. */
public Distribution getDistribution() {
return distribution;
}
+ /**
+ * The related distribution, a jar file with OSGi metadata referenced by a
+ * {@link Resource}.
+ */
public ResourceDistribution getResourceDistribution() {
return distribution;
}
+ /** TODO: reference the {@link OsgiRuntime} as target data? */
public TargetData getTargetData() {
throw new UnsupportedOperationException();
}
}
/**
- * To be used for optimization when looking in the bundle context. Can
- * therefore be null.
+ * Bundle ID used by the OSGi runtime. To be used for optimization when
+ * looking in the bundle context. Can therefore be null.
*/
public Long getInternalBundleId() {
return internalBundleId;
this.internalBundleId = internalBundleId;
}
- public String getLabel() {
- return label;
+ /** Value of the <code>Bundle-Name</code> directive. */
+ public String getTitle() {
+ return title;
}
- public void setLabel(String label) {
- this.label = label;
+ public void setTitle(String label) {
+ this.title = label;
}
+ /** Value of the <code>Bundle-Description</code> directive. */
public String getDescription() {
return description;
}
this.description = description;
}
+ public ModuleDescriptor getModuleDescriptor() {
+ ModuleDescriptor moduleDescriptor = new ModuleDescriptor();
+ moduleDescriptor.setName(getName());
+ moduleDescriptor.setVersion(getVersion());
+ moduleDescriptor.setDescription(description);
+ moduleDescriptor.setTitle(title);
+ return moduleDescriptor;
+ }
}