svn commit: r658211 - in /felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole: Action.java ConfigurationPrinter.java Render.java

[fm...@apache.org]

Author: fmeschbe
Date: Tue May 20 04:53:28 2008
New Revision: 658211

URL: http://svn.apache.org/viewvc?rev=658211&view=rev
Log:
Some JavaDoc for the exported service interfaces

Modified:
    felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Action.java
    felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/ConfigurationPrinter.java
    felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Render.java

Modified: felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Action.java
URL: http://svn.apache.org/viewvc/felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Action.java?rev=658211&r1=658210&r2=658211&view=diff
==============================================================================
--- felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Action.java (original)
+++ felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Action.java Tue May 20 04:53:28 2008
@@ -24,6 +24,15 @@
 import javax.servlet.http.HttpServletResponse;
 
 
+/**
+ * The <code>Action</code> interface defines a service interface for actions
+ * to be plugged into the web console.
+ * <p>
+ * <strong>NOTE: This interface is just an intermediate solution for making the
+ * web console extensible. Future releases of the web console will remove this
+ * and the {@link Render} interfaces and use the <code>javax.servlet.Servlet</code>
+ * interface with predefined service registration properties instead.</strong>
+ */
 public interface Action
 {
 

Modified: felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/ConfigurationPrinter.java
URL: http://svn.apache.org/viewvc/felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/ConfigurationPrinter.java?rev=658211&r1=658210&r2=658211&view=diff
==============================================================================
--- felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/ConfigurationPrinter.java (original)
+++ felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/ConfigurationPrinter.java Tue May 20 04:53:28 2008
@@ -22,15 +22,33 @@
 import java.io.PrintWriter;
 
 
+/**
+ * The <code>ConfigurationPrinter</code> is a service interface to be used by
+ * providers which want to hook into the display of the current configuration
+ * of the OSGi framework.
+ */
 public interface ConfigurationPrinter
 {
 
+    /**
+     * The service name under which services of this class must be registered
+     * to be picked for inclusion in the configuration report.
+     */
     static final String SERVICE = ConfigurationPrinter.class.getName();
 
 
+    /**
+     * Returns a human readable title string to be place in front of the configuration
+     * report generated by the {@link #printConfiguration(PrintWriter)} method.
+     */
     String getTitle();
 
 
+    /**
+     * Prints the configuration report to the given <code>printWriter</code>.
+     * Implementations are free to print whatever information they deem useful.
+     * The <code>printWriter</code> may be flushed but must not be closed.
+     */
     void printConfiguration( PrintWriter printWriter );
 
 }

Modified: felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Render.java
URL: http://svn.apache.org/viewvc/felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Render.java?rev=658211&r1=658210&r2=658211&view=diff
==============================================================================
--- felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Render.java (original)
+++ felix/trunk/webconsole/src/main/java/org/apache/felix/webconsole/Render.java Tue May 20 04:53:28 2008
@@ -25,7 +25,13 @@
 
 
 /**
- * The <code>Render</code> TODO
+ * The <code>Render</code> interface defines a service interface for
+ * information renderings to be plugged into the web console.
+ * <p>
+ * <strong>NOTE: This interface is just an intermediate solution for making the
+ * web console extensible. Future releases of the web console will remove this
+ * and the {@link Action} interfaces and use the <code>javax.servlet.Servlet</code>
+ * interface with predefined service registration properties instead.</strong>
  */
 public interface Render
 {