X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;ds=sidebyside;f=runtime%2Forg.argeo.slc.support.osgi%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fosgi%2FOsgiBundle.java;h=0be7d02e9e19e7e2f23913327962f39265c4ebb5;hb=16e2ffb035a4c41576acc74efb37610c7aec1887;hp=19b357285a6f886b44670f906f831495787ac8d0;hpb=c092f2c4564f7238f2960bc005c5a2202732f44e;p=gpl%2Fargeo-slc.git

diff --git a/runtime/org.argeo.slc.support.osgi/src/main/java/org/argeo/slc/osgi/OsgiBundle.java b/runtime/org.argeo.slc.support.osgi/src/main/java/org/argeo/slc/osgi/OsgiBundle.java
index 19b357285..0be7d02e9 100644
--- a/runtime/org.argeo.slc.support.osgi/src/main/java/org/argeo/slc/osgi/OsgiBundle.java
+++ b/runtime/org.argeo.slc.support.osgi/src/main/java/org/argeo/slc/osgi/OsgiBundle.java
@@ -1,8 +1,24 @@
+/*
+ * Copyright (C) 2010 Mathieu Baudier <mbaudier@argeo.org>
+ *
+ * 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.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;
@@ -10,8 +26,12 @@ 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 = -1970854723780452072L;
+
 	private ResourceDistribution distribution;
 
 	private Long internalBundleId;
@@ -36,6 +56,17 @@ public class OsgiBundle extends BasicNameVersion implements Module {
 		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)
@@ -44,26 +75,35 @@ public class OsgiBundle extends BasicNameVersion implements Module {
 			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();
 	}
@@ -73,8 +113,8 @@ public class OsgiBundle extends BasicNameVersion implements Module {
 	}
 
 	/**
-	 * 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;
@@ -85,6 +125,7 @@ public class OsgiBundle extends BasicNameVersion implements Module {
 		this.internalBundleId = internalBundleId;
 	}
 
+	/** Value of the <code>Bundle-Name</code> directive. */
 	public String getLabel() {
 		return label;
 	}
@@ -93,6 +134,7 @@ public class OsgiBundle extends BasicNameVersion implements Module {
 		this.label = label;
 	}
 
+	/** Value of the <code>Bundle-Description</code> directive. */
 	public String getDescription() {
 		return description;
 	}