You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by dj...@apache.org on 2016/05/11 20:52:53 UTC

[1/3] incubator-quarks git commit: javadoc improvements

Repository: incubator-quarks
Updated Branches:
  refs/heads/master db196c185 -> dc0ce2930


javadoc improvements


Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks/commit/4381426f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks/tree/4381426f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks/diff/4381426f

Branch: refs/heads/master
Commit: 4381426fb4af4a490bad72caec26e957379d4ac1
Parents: fa48c5f
Author: Dan Debrunner <dj...@debrunners.com>
Authored: Tue May 10 16:18:39 2016 -0700
Committer: Dan Debrunner <dj...@debrunners.com>
Committed: Tue May 10 16:18:39 2016 -0700

----------------------------------------------------------------------
 .../quarks/topology/mbeans/ApplicationServiceMXBean.java     | 5 +++++
 .../java/quarks/runtime/jsoncontrol/JsonControlService.java  | 7 +++++--
 .../main/java/quarks/runtime/jsoncontrol/package-info.java   | 8 +++++---
 3 files changed, 15 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/4381426f/api/topology/src/main/java/quarks/topology/mbeans/ApplicationServiceMXBean.java
----------------------------------------------------------------------
diff --git a/api/topology/src/main/java/quarks/topology/mbeans/ApplicationServiceMXBean.java b/api/topology/src/main/java/quarks/topology/mbeans/ApplicationServiceMXBean.java
index 73ad985..591e5f1 100644
--- a/api/topology/src/main/java/quarks/topology/mbeans/ApplicationServiceMXBean.java
+++ b/api/topology/src/main/java/quarks/topology/mbeans/ApplicationServiceMXBean.java
@@ -20,6 +20,11 @@ package quarks.topology.mbeans;
 
 import quarks.topology.services.ApplicationService;
 
+/**
+ * Control MBean for the application service.
+ * 
+ * @see ApplicationService
+ */
 public interface ApplicationServiceMXBean {
     
     String TYPE = "appService";

http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/4381426f/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
----------------------------------------------------------------------
diff --git a/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java b/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
index 44622e6..0c63e5f 100644
--- a/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
+++ b/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
@@ -36,9 +36,12 @@ import quarks.execution.services.Controls;
 
 /**
  * Control service that accepts control instructions as JSON objects.
+ * <BR>
+ * A JSON object representing a control request can be passed
+ * to {@link #controlRequest(JsonObject)} to invoke a control
+ * operation (method) on a registered MBean.
  * 
- * Currently just supports operations with no arguments as
- * a work in progress.
+ *  @see quarks.runtime.jsoncontrol Format of control request operation
  */
 public class JsonControlService implements ControlService {
 

http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/4381426f/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
----------------------------------------------------------------------
diff --git a/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java b/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
index 00143a6..9eaa4af 100644
--- a/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
+++ b/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
@@ -16,11 +16,10 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 */
-package quarks.runtime.jsoncontrol;
 
 /**
  * Control service that takes a Json message and invokes
- * an action on a control service MBean.
+ * an operation on a control service MBean.
  * 
  * <H3>Operations</H3>
  * A JSON object passed to {@link quarks.runtime.jsoncontrol.JsonControlService#controlRequest(com.google.gson.JsonObject) controlRequest} with these name/value pairs is
@@ -32,4 +31,7 @@ package quarks.runtime.jsoncontrol;
  * <LI>{@code op=}<em>name</em></LI>
  * <LI>{@code arguments=}<em>optional list of arguments</em></LI>
  * </UL>
- */
\ No newline at end of file
+ * 
+ */
+
+package quarks.runtime.jsoncontrol;
\ No newline at end of file


[3/3] incubator-quarks git commit: Merge branch 'pr-115'

Posted by dj...@apache.org.
Merge branch 'pr-115'


Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks/commit/dc0ce293
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks/tree/dc0ce293
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks/diff/dc0ce293

Branch: refs/heads/master
Commit: dc0ce2930b1d58222022101429e84a750064bbeb
Parents: db196c1 4a75437
Author: Daniel J. Debrunner <de...@us.ibm.com>
Authored: Wed May 11 13:53:32 2016 -0700
Committer: Daniel J. Debrunner <de...@us.ibm.com>
Committed: Wed May 11 13:53:32 2016 -0700

----------------------------------------------------------------------
 .../mbeans/ApplicationServiceMXBean.java        |  5 +++
 .../java/quarks/providers/iot/IotProvider.java  |  4 --
 .../java/quarks/providers/iot/package-info.java | 46 +++++++++++++++++++-
 .../runtime/jsoncontrol/JsonControlService.java |  7 ++-
 .../runtime/jsoncontrol/package-info.java       | 20 +++++----
 5 files changed, 67 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/dc0ce293/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
----------------------------------------------------------------------
diff --cc runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
index c0b48d0,0c63e5f..83eaf79
--- a/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
+++ b/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/JsonControlService.java
@@@ -39,13 -36,14 +39,16 @@@ import quarks.execution.services.Contro
  
  /**
   * Control service that accepts control instructions as JSON objects.
+  * <BR>
+  * A JSON object representing a control request can be passed
+  * to {@link #controlRequest(JsonObject)} to invoke a control
+  * operation (method) on a registered MBean.
   * 
-  * Currently just supports operations with no arguments as
-  * a work in progress.
+  *  @see quarks.runtime.jsoncontrol Format of control request operation
   */
  public class JsonControlService implements ControlService {
 +    
 +    private static final Logger logger = LoggerFactory.getLogger(ControlService.class);
  
      /**
       * Key for the type of the control MBean in a JSON request.


[2/3] incubator-quarks git commit: Start documenting provider commands

Posted by dj...@apache.org.
Start documenting provider commands


Project: http://git-wip-us.apache.org/repos/asf/incubator-quarks/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-quarks/commit/4a754374
Tree: http://git-wip-us.apache.org/repos/asf/incubator-quarks/tree/4a754374
Diff: http://git-wip-us.apache.org/repos/asf/incubator-quarks/diff/4a754374

Branch: refs/heads/master
Commit: 4a7543743b10c6a10106fc4bdc690248d9b196c5
Parents: 4381426
Author: Dan Debrunner <dj...@debrunners.com>
Authored: Tue May 10 17:22:15 2016 -0700
Committer: Dan Debrunner <dj...@debrunners.com>
Committed: Tue May 10 17:22:15 2016 -0700

----------------------------------------------------------------------
 .../java/quarks/providers/iot/IotProvider.java  |  4 --
 .../java/quarks/providers/iot/package-info.java | 46 +++++++++++++++++++-
 .../runtime/jsoncontrol/package-info.java       | 14 +++---
 3 files changed, 53 insertions(+), 11 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/4a754374/providers/iot/src/main/java/quarks/providers/iot/IotProvider.java
----------------------------------------------------------------------
diff --git a/providers/iot/src/main/java/quarks/providers/iot/IotProvider.java b/providers/iot/src/main/java/quarks/providers/iot/IotProvider.java
index dea4e1a..e0c2723 100644
--- a/providers/iot/src/main/java/quarks/providers/iot/IotProvider.java
+++ b/providers/iot/src/main/java/quarks/providers/iot/IotProvider.java
@@ -63,10 +63,6 @@ import quarks.topology.services.ApplicationService;
  * </UL>
  * System applications provide this functionality:
  * <UL>
- * <LI>
- * </LI>
- * </UL>
- * <UL>
  * <LI>Single connection to the message hub using an {@code IotDevice}
  * using {@link IotDevicePubSub}.
  * Applications using this provider that want to connect

http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/4a754374/providers/iot/src/main/java/quarks/providers/iot/package-info.java
----------------------------------------------------------------------
diff --git a/providers/iot/src/main/java/quarks/providers/iot/package-info.java b/providers/iot/src/main/java/quarks/providers/iot/package-info.java
index 5044636..befe330 100644
--- a/providers/iot/src/main/java/quarks/providers/iot/package-info.java
+++ b/providers/iot/src/main/java/quarks/providers/iot/package-info.java
@@ -20,6 +20,50 @@ under the License.
 /**
  * Iot provider that allows multiple applications to
  * share an {@code IotDevice}.
+ * 
+ * <H3>IoT device</H3>
+ * 
+ * <H3>Application registration</H3>
+ * The provider includes an {@link quarks.topology.services.ApplicationService ApplicationService} that allows applications
+ * to be registered by name. Once registered an application can be started (and stopped) remotely
+ * through the control service using a device command.
+ * 
+ * <H3>Supported device commands</H3>
+ * This provider supports a number of system level device commands to control the applications
+ * running within it.
+ * <H4>Control service</H4>
+ * Device commands with the command identifier '{@link quarks.connectors.iot.Commands#CONTROL_SERVICE quarksControl}'
+ * are sent to the provider's control service, an instance of {@link quarks.runtime.jsoncontrol.JsonControlService JsonControlService}.
+ * This allows invocation of an operation against a control mbean registered with the
+ * control service, either by an application or the provider itself.
+ * <BR>
+ * The command's data (JSON) uniquely identifies a control MBean through its type and
+ * alias, and indicates the operation to call on the MBean and the arguments to
+ * pass the control MBean.
+ * <BR>
+ * Thus any control operation can be remotely invoked through a {@code quarksControl} device command,
+ * including arbitrary control mbeans registered by applications.
+ * 
+ * <H4>Provider operations</H4>
+ * <TABLE border="1">
+ * <tr>
+ *     <th>Operation</th><th>Command identifier</th>
+ *     <th>Type</th><th>Alias</th><th>Method</th><th>Arguments</th>
+ *     <th>Control MBean</th>
+ * </tr>
+ * <tr>
+ *    <th rowspan="2">Submit (start) a registered application</th>
+ *    <td>{@code quarksControl}</td><td>{@code appService}</td>
+ *    <td>{@code quarks}</td><td>{@link quarks.topology.mbeans.ApplicationServiceMXBean#submit(String, String) submit}</td>
+ *    <td><em>{@code [applicationName, config]}</em></td>
+ *    <td>{@link quarks.topology.mbeans.ApplicationServiceMXBean ApplicationServiceMXBean}</td>
+ * </tr>
+ * </tr>
+ * <th>Sample command data</th>
+ * <td colspan=5>{@code {"type":"appService","alias":"quarks","op":"submit","args":["Heartbeat",{}]}}</td>
+ * </tr>
+ * <tr></tr>
+ * </TABLE>
+ * 
  */
 package quarks.providers.iot;
-

http://git-wip-us.apache.org/repos/asf/incubator-quarks/blob/4a754374/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
----------------------------------------------------------------------
diff --git a/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java b/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
index 9eaa4af..9c10250 100644
--- a/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
+++ b/runtime/jsoncontrol/src/main/java/quarks/runtime/jsoncontrol/package-info.java
@@ -24,14 +24,16 @@ under the License.
  * <H3>Operations</H3>
  * A JSON object passed to {@link quarks.runtime.jsoncontrol.JsonControlService#controlRequest(com.google.gson.JsonObject) controlRequest} with these name/value pairs is
  * handled as an operation resulting in a method call to a
- * void method on a control service MBean interface.
+ * void method on a control service MBean interface. 
  * <UL>
- * <LI>{@code type=}<em>type</em></LI>
- * <LI>{@code alias=}<em>alias</em></LI>
- * <LI>{@code op=}<em>name</em></LI>
- * <LI>{@code arguments=}<em>optional list of arguments</em></LI>
+ * <LI>{@code type=}<em>type</em> - MBean type.</LI>
+ * <LI>{@code alias=}<em>alias - Alias of the MBean.</em></LI>
+ * <LI>{@code op=}<em>name</em> - Name of the operation to invoke, this is the method name on the MBean.</LI>
+ * <LI>{@code arguments=}<em>optional list of arguments</em> - Arguments passed to the operation (method).</LI>
  * </UL>
- * 
+ * The MBean must be uniquely identified through
+ * its <em>type</em> and <em>alias</em> and previously registered using 
+ * {@link quarks.execution.services.ControlService#registerControl(String, String, String, Class, Object) registerControl()}.
  */
 
 package quarks.runtime.jsoncontrol;
\ No newline at end of file