DPML Notify

[mcconnell at BerliOS <mcconnell AT mail.berlios.de>]

Author: mcconnell
Date: 2007-02-09 03:35:32 +0100 (Fri, 09 Feb 2007)
New Revision: 1865

Modified:
   trunk/main/metro/part/src/main/net/dpml/appliance/Appliance.java
   trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceConnector.java
   trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceEvent.java
   trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceFactory.java
   trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceListener.java
   trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceManager.java
   trunk/main/metro/part/src/main/net/dpml/appliance/PlanManager.java
   trunk/main/metro/part/src/main/net/dpml/appliance/package-info.java
Log:
housekeeping

Modified: trunk/main/metro/part/src/main/net/dpml/appliance/Appliance.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/Appliance.java    
2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/Appliance.java    
2007-02-09 02:35:32 UTC (rev 1865)
@@ -23,31 +23,39 @@
 import java.rmi.RemoteException;
 import java.util.concurrent.TimeUnit;
 
-
 /**
- * Appliance interface.
+ * Appliance interface.  An appliance represents a component or component 
collection
+ * that can be comissioned and decommissioned.
  *
  * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
  * @version @PROJECT-VERSION@
  */
 public interface Appliance extends Remote
 {
+   /**
+    * Add an appliance listener to the appliance.
+    * @param listener the appliance listener
+    * @exception RemoteException if a RMI error occurs
+    */
     void addApplianceListener( ApplianceListener listener ) throws 
RemoteException;
     
+   /**
+    * Remove an appliance listener from the appliance.
+    * @param listener the appliance listener
+    * @exception RemoteException if a RMI error occurs
+    */
     void removeApplianceListener( ApplianceListener listener ) throws 
RemoteException;
     
+   /**
+    * Commission the appliance.
+    * @exception IOException if a I/O error occurs
+    */
     void commission() throws IOException;
     
-    void decommission() throws RemoteException;
-    
    /**
-    * Return a value assignable to the supplied remote type or null if the 
type
-    * cannot be resolved from the underlying component.
-    * @param type the service type
-    * @return an instance of the type or null
-    * @exception IOException if an IO error occurs
+    * Decommission the appliance.
+    * @exception RemoteException if a RMI error occurs
     */
-    //public <T>T getContentForClass( Class<T> type ) throws IOException;
-    
+    void decommission() throws RemoteException;
 }
 

Modified: 
trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceConnector.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceConnector.java 
  2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceConnector.java 
  2007-02-09 02:35:32 UTC (rev 1865)
@@ -30,12 +30,18 @@
 public interface ApplianceConnector extends Remote
 {
    /**
-    * Connect a appliance to the station.
+    * Connect an appliance to the connector.
     * @param appliance the appliance 
     * @exception RemoteException if a remote error occurs
     */
     void connect( Appliance appliance ) throws RemoteException;
     
+   /**
+    * Retrieve the connected appliance.
+    * @param units the timout units
+    * @param timeout duration (in units) to wait for a connection
+    * @exception IOException if an I/O error occurs
+    */
     Appliance getAppliance( TimeUnit units, int timeout ) throws IOException;
     
 }

Modified: 
trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceEvent.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceEvent.java     
  2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceEvent.java     
  2007-02-09 02:35:32 UTC (rev 1865)
@@ -23,7 +23,7 @@
 import net.dpml.runtime.Status;
 
 /**
- * Event triggered as a result of a state change.
+ * Event triggered as a result of a state change within an appliance.
  *
  * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
  * @version @PROJECT-VERSION@
@@ -41,7 +41,8 @@
    /**
     * Construct a new <code>StateEvent</code>.
     *
-    * @param source the source component
+    * @param source the source appliance
+    * @param status the appliance state
     */
     public ApplianceEvent( final Appliance source, Status status )
     {

Modified: 
trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceFactory.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceFactory.java   
  2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceFactory.java   
  2007-02-09 02:35:32 UTC (rev 1865)
@@ -22,7 +22,7 @@
 import java.net.URLConnection;
 
 /**
- * Interface implementated by remote listeners to state change events.
+ * Interface implementated by appliance factories.
  *
  * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
  * @version @PROJECT-VERSION@
@@ -30,7 +30,7 @@
 public interface ApplianceFactory
 {
    /**
-    * Create a new appliance using the supplied connection object.
+    * Create a new appliance using the supplied url connection and partition.
     * @param connection the URL connection
     * @param partition an optional partition name
     * @return the appliance

Modified: 
trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceListener.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceListener.java  
  2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceListener.java  
  2007-02-09 02:35:32 UTC (rev 1865)
@@ -24,7 +24,7 @@
 import java.rmi.RemoteException;
 
 /**
- * Interface implementated by remote listeners to state change events.
+ * Interface implementated by remote listeners to appliance state change 
events.
  *
  * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
  * @version @PROJECT-VERSION@
@@ -34,7 +34,7 @@
    /**
     * Notify the listener of an event within the appliance.
     *
-    * @param event the comnponent event
+    * @param event the appliance event
     * @exception RemoteException if a remote transport error occurs
     */
     void applianceChanged( final ApplianceEvent event ) throws 
RemoteException;

Modified: 
trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceManager.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceManager.java   
  2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/ApplianceManager.java   
  2007-02-09 02:35:32 UTC (rev 1865)
@@ -23,7 +23,7 @@
 import javax.management.MXBean;
 
 /**
- * Management interface for applications.
+ * Management interface for an appliance.
  *
  * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
  * @version @PROJECT-VERSION@
@@ -32,7 +32,7 @@
 public interface ApplianceManager extends Remote
 {
    /**
-    * Returns the part URI as a string.
+    * Returns the codebase URI as a string.
     * @return the codebase uri
     */
     String getCodebaseURI() throws RemoteException;

Modified: trunk/main/metro/part/src/main/net/dpml/appliance/PlanManager.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/PlanManager.java  
2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/PlanManager.java  
2007-02-09 02:35:32 UTC (rev 1865)
@@ -21,7 +21,7 @@
 import javax.management.MXBean;
 
 /**
- * Management interface for applications.
+ * Management interface for deployment plan.
  *
  * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
  * @version @PROJECT-VERSION@
@@ -29,5 +29,9 @@
 @MXBean
 public interface PlanManager extends ApplianceManager
 {
+   /**
+    * Return the array of appliance managers established within the plan.
+    * @return the managed appliance managers
+    */
     ApplianceManager[] getApplianceManagers();
 }

Modified: trunk/main/metro/part/src/main/net/dpml/appliance/package-info.java
===================================================================
--- trunk/main/metro/part/src/main/net/dpml/appliance/package-info.java 
2007-02-09 02:24:49 UTC (rev 1864)
+++ trunk/main/metro/part/src/main/net/dpml/appliance/package-info.java 
2007-02-09 02:35:32 UTC (rev 1865)
@@ -17,7 +17,7 @@
  */
 
 /**
- * <p>Interfaces represening a managed process.</p>
+ * <p>Interfaces representing managed processes.</p>
  * 
  * @author <a href="@PUBLISHER-URL@">@PUBLISHER-NAME@</a>
  * @version @PROJECT-VERSION@