You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by ma...@apache.org on 2009/01/28 21:48:17 UTC

svn commit: r738617 - in /felix/trunk/dependencymanager: ./ src/main/java/org/apache/felix/dependencymanager/

Author: marrs
Date: Wed Jan 28 20:48:16 2009
New Revision: 738617

URL: http://svn.apache.org/viewvc?rev=738617&view=rev
Log:
Updated the POM and cleaned up some code (documentation) in preparation for the release.

Modified:
    felix/trunk/dependencymanager/pom.xml
    felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java
    felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponent.java
    felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponentDependency.java
    felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceDependency.java
    felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceImpl.java

Modified: felix/trunk/dependencymanager/pom.xml
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/pom.xml?rev=738617&r1=738616&r2=738617&view=diff
==============================================================================
--- felix/trunk/dependencymanager/pom.xml (original)
+++ felix/trunk/dependencymanager/pom.xml Wed Jan 28 20:48:16 2009
@@ -27,19 +27,19 @@
   <modelVersion>4.0.0</modelVersion>
   <packaging>bundle</packaging>
   <name>Apache Felix Dependency Manager</name>
-  <version>1.1.0-SNAPSHOT</version>
+  <version>2.0.0-SNAPSHOT</version>
   <artifactId>org.apache.felix.dependencymanager</artifactId>
   <dependencies>
     <dependency>
       <groupId>${pom.groupId}</groupId>
       <artifactId>org.osgi.core</artifactId>
-      <version>1.0.0</version>
+      <version>1.2.0</version>
       <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>${pom.groupId}</groupId>
       <artifactId>org.osgi.compendium</artifactId>
-      <version>1.0.0</version>
+      <version>1.2.0</version>
       <scope>provided</scope>
     </dependency>
   </dependencies>

Modified: felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java?rev=738617&r1=738616&r2=738617&view=diff
==============================================================================
--- felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java (original)
+++ felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java Wed Jan 28 20:48:16 2009
@@ -54,6 +54,7 @@
      * @return this service
      */
     public Service setInterface(String serviceName, Dictionary properties);
+    
     /**
      * Sets the public interfaces under which this service should be registered
      * in the OSGi service registry.
@@ -217,8 +218,10 @@
 	 * method to invoke. The method should return the implementation, and can
 	 * use any method to create it. Actually, this can be used together with
 	 * <code>setComposition</code> to create a composition of instances that
-	 * work together to implement a service. The factory method is called on
-	 * ??? TODO ???
+	 * work together to implement a service.
+	 * <p>
+	 * Note that currently, there is no default for the factory, so please use
+	 * <code>setFactory(factory, createMethod)</code> instead.
 	 * 
 	 * @param createMethod the name of the create method
 	 */

Modified: felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponent.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponent.java?rev=738617&r1=738616&r2=738617&view=diff
==============================================================================
--- felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponent.java (original)
+++ felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponent.java Wed Jan 28 20:48:16 2009
@@ -19,15 +19,24 @@
 package org.apache.felix.dependencymanager;
 
 /**
- * Describes a service component.
+ * Describes a service component. Service components form descriptions of services
+ * that are managed by the dependency manager. They can be used to query their state
+ * for monitoring tools. The dependency manager shell command is an example of
+ * such a tool.
  * 
  * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
  */
 public interface ServiceComponent {
+    /** Names for the states of this component. */
     public static final String[] STATE_NAMES = { "unregistered", "registered" };
+    /** State constant for an unregistered component. */
     public static final int STATE_UNREGISTERED = 0;
+    /** State constant for a registered component. */
     public static final int STATE_REGISTERED = 1;
+    /** Returns a list of dependencies associated with this service component. */
     public ServiceComponentDependency[] getComponentDependencies();
+    /** Returns the name of this service component. */
     public String getName();
+    /** Returns the state of this service component. */
     public int getState();
 }

Modified: felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponentDependency.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponentDependency.java?rev=738617&r1=738616&r2=738617&view=diff
==============================================================================
--- felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponentDependency.java (original)
+++ felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceComponentDependency.java Wed Jan 28 20:48:16 2009
@@ -19,22 +19,33 @@
 package org.apache.felix.dependencymanager;
 
 /**
- * Describes a service component dependency.
+ * Describes a service component dependency. They form descriptions of dependencies
+ * that are managed by the dependency manager. They can be used to query their state
+ * for monitoring tools. The dependency manager shell command is an example of
+ * such a tool.
  * 
  * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
  */
 public interface ServiceComponentDependency {
+    /** Names for the states of this dependency. */
     public static final String[] STATE_NAMES = { 
         "optional unavailable", 
         "optional available", 
         "required unavailable", 
         "required available" 
         };
+    /** State constant for an unavailable, optional dependency. */
     public static final int STATE_UNAVAILABLE_OPTIONAL = 0;
+    /** State constant for an available, optional dependency. */
     public static final int STATE_AVAILABLE_OPTIONAL = 1;
+    /** State constant for an unavailable, required dependency. */
     public static final int STATE_UNAVAILABLE_REQUIRED = 2;
+    /** State constant for an available, required dependency. */
     public static final int STATE_AVAILABLE_REQUIRED = 3;
+    /** Returns the name of this dependency. */
     public String getName();
+    /** Returns the name of the type of this dependency. */
     public String getType();
+    /** Returns the state of this dependency. */
     public int getState();
 }

Modified: felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceDependency.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceDependency.java?rev=738617&r1=738616&r2=738617&view=diff
==============================================================================
--- felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceDependency.java (original)
+++ felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceDependency.java Wed Jan 28 20:48:16 2009
@@ -571,7 +571,6 @@
         return this;
     }
     
-    
     private void ensureNotActive() {
         if (m_tracker != null) {
             throw new IllegalStateException("Cannot modify state while active.");

Modified: felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceImpl.java
URL: http://svn.apache.org/viewvc/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceImpl.java?rev=738617&r1=738616&r2=738617&view=diff
==============================================================================
--- felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceImpl.java (original)
+++ felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceImpl.java Wed Jan 28 20:48:16 2009
@@ -568,9 +568,9 @@
 		        		}
 		        	}
 		        	else {
-		        		// TODO!!!! where does the factory come from if not explicitly defined
-		        		// could be the activator?
-		        		// could be ???
+		        		// TODO review if we want to try to default to something if not specified
+		        	    // for now the JavaDoc of setFactory(method) reflects the fact that we need
+		        	    // to review it
 		        	}
 		        	if (factory == null) {
                         m_logger.log(Logger.LOG_ERROR, "Factory cannot be null.");