http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html b/content/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html index 9e63250..2689ddc 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html +++ b/content/javadoc/latest/org/apache/edgent/connectors/iot/package-use.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:52 KST 2016 --> -<title>Uses of Package org.apache.edgent.connectors.iot (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:13 EST 2017 --> +<title>Uses of Package org.apache.edgent.connectors.iot (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,7 +12,7 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Uses of Package org.apache.edgent.connectors.iot (Edgent v1.0.0)"; + parent.document.title="Uses of Package org.apache.edgent.connectors.iot (Edgent v1.1.0)"; } } catch(err) { @@ -91,7 +91,7 @@ <tr class="rowColor"> <td class="colFirst"><a href="#org.apache.edgent.connectors.iot">org.apache.edgent.connectors.iot</a></td> <td class="colLast"> -<div class="block">Edgent device connector API to a message hub.</div> +<div class="block">Edgent IoT device and IoT Gateway device connector API to an IoT message hub.</div> </td> </tr> <tr class="altColor"> @@ -137,7 +137,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.apps.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -154,7 +154,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.connectors.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -171,7 +171,12 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.connectors.iotp">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotGateway.html#org.apache.edgent.connectors.iotp">IotGateway</a> +<div class="block">A generic IoT gateway device IoT hub connector.</div> </td> </tr> </tbody> @@ -188,7 +193,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.connectors.mqtt.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -205,7 +210,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.providers.iot">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -222,7 +227,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.samples.connectors.iotp">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -239,7 +244,7 @@ <tbody> <tr class="altColor"> <td class="colOne"><a href="../../../../../org/apache/edgent/connectors/iot/class-use/IotDevice.html#org.apache.edgent.test.svt.apps.iotp">IotDevice</a> -<div class="block">Generic Internet of Things device connector.</div> +<div class="block">A generic IoT device IoT hub connector.</div> </td> </tr> </tbody> @@ -295,6 +300,6 @@ <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/0684ec9c/content/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html ---------------------------------------------------------------------- diff --git a/content/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html b/content/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html index 078309c..b9493a9 100644 --- a/content/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html +++ b/content/javadoc/latest/org/apache/edgent/connectors/iotp/IotpDevice.html @@ -1,10 +1,10 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> -<html llang="en"> +<html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_60) on Sat Nov 19 21:36:49 KST 2016 --> -<title>IotpDevice (Edgent v1.0.0)</title> -<meta name="date" content="2016-11-19"> +<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:09 EST 2017 --> +<title>IotpDevice (Edgent v1.1.0)</title> +<meta name="date" content="2017-02-26"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> @@ -12,13 +12,13 @@ <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="IotpDevice (Edgent v1.0.0)"; + parent.document.title="IotpDevice (Edgent v1.1.0)"; } } catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":10,"i9":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li>Prev Class</li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/edgent/connectors/iotp/IotpDevice.html" target="_top">Frames</a></li> @@ -116,7 +116,7 @@ var activeTableTab = "activeTableTab"; <pre>public class <span class="typeNameLabel">IotpDevice</span> extends java.lang.Object implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></pre> -<div class="block">Connector for IBM Watson IoT Platform. +<div class="block">A Device Connector to IBM Watson IoT Platform (WIoTP). <BR> IBM Watson IoT Platform is a cloud based internet of things scale message hub that provides a device model on top of MQTT. @@ -125,11 +125,36 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot"><code>IotProvider</code></a>. <BR> <em>Note IBM Watson IoT Platform was previously known as - IBM Internet of Things Foundation.</em></div> + IBM Internet of Things Foundation.</em> + <p> + This connector is a thin wrapper over the WIoTP <code>DeviceClient</code> Java API. + The constructor <code>Properties</code> and <code>optionsFile</code> contents are those + demanded by <code>DeviceClient</code>. + <p> + For more complex use cases this connector can be constructed to use + a supplied <code>DeviceClient</code>. This gives an application complete + control over the construction and configuration of the underlying + connection to WIoTP. + <p> + An application that wants to be a WIoTP <i>managed device</i> + and an Edgent application must construct a WIoTP <code>ManagedDevice</code> instance + and construct this device connector using it. + <P> + If the following link's page doesn't render in javadoc, paste it into a browser window. + <BR> + See the IBM Watson IoT Platform documentation for Developing devices at + <a href="https://internetofthings.ibmcloud.com/">https://internetofthings.ibmcloud.com/</a> + <p> + See <a href="https://github.com/ibm-watson-iot/iot-java/releases">WIoTP Java Client Library Releases</a> + for general information. + <p> + See <a href="https://github.com/ibm-watson-iot/iot-java/tree/master#migration-from-release-015-to-021">WIoTP Migration from release 0.1.5 to 0.2.1</a> + for details of changes that occurred to device event payloads + and how to revert the behavior if needed. + <p></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> -<dd><code>Edgent generic device model</code>, -<a href="http://www.ibm.com/internet-of-things/iot-platform.html">IBM Watson IoT Platform</a>, +<dd><a href="../../../../../org/apache/edgent/connectors/iot/package-summary.html">Edgent generic device model</a>, <a href="../../../../../org/apache/edgent/samples/connectors/iotp/IotpSensors.html" title="class in org.apache.edgent.samples.connectors.iotp"><code>Sample application</code></a></dd> </dl> </li> @@ -162,7 +187,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <!-- --> </a> <h3>Fields inherited from interface org.apache.edgent.connectors.iot.<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></h3> -<code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_FORMAT">CMD_FORMAT</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_ID">CMD_ID</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD">CMD_PAYLOAD</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_TS">CMD_TS</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#RESERVED_ID_PREFIX">RESERVED_ID_PREFIX</a></code></li> +<code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_DEVICE">CMD_DEVICE</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_FORMAT">CMD_FORMAT</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_ID">CMD_ID</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_PAYLOAD">CMD_PAYLOAD</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#CMD_TS">CMD_TS</a>, <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#RESERVED_ID_PREFIX">RESERVED_ID_PREFIX</a></code></li> </ul> </li> </ul> @@ -178,16 +203,21 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#IotpDevice-org.apache.edgent.topology.Topology-com.ibm.iotf.client.device.DeviceClient-">IotpDevice</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, + com.ibm.iotf.client.device.DeviceClient deviceClient)</code> +<div class="block">Create a connector using the supplied WIoTP <code>DeviceClient</code>.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#IotpDevice-org.apache.edgent.topology.Topology-java.io.File-">IotpDevice</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.io.File optionsFile)</code> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service.</div> +<div class="block">Create a connector for the IoT device specified by <code>optionsFile</code>.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#IotpDevice-org.apache.edgent.topology.Topology-java.util.Properties-">IotpDevice</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.util.Properties options)</code> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service with the device - specified by <code>options</code>.</div> +<div class="block">Create a connector for the IoT device specified by <code>options</code>.</div> </td> </tr> </table> @@ -229,25 +259,56 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </td> </tr> <tr id="i3" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#getDeviceId--">getDeviceId</a></span>()</code> +<div class="block">Get the device's unique opaque device identifier.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#getDeviceType--">getDeviceType</a></span>()</code> +<div class="block">Get the device's opaque device type identifier.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#httpEvents-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-">httpEvents</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.String> eventId, + <a href="../../../../../org/apache/edgent/function/UnaryOperator.html" title="interface in org.apache.edgent.function">UnaryOperator</a><com.google.gson.JsonObject> payload)</code> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#httpEvents-org.apache.edgent.topology.TStream-java.lang.String-">httpEvents</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + java.lang.String eventId)</code> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html" title="class in org.apache.edgent.connectors.iotp">IotpDevice</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#quickstart-org.apache.edgent.topology.Topology-java.lang.String-">quickstart</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.lang.String deviceId)</code> <div class="block">Create an <code>IotpDevice</code> connector to the Quickstart service.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#topology--">topology</a></span>()</code> <div class="block">Topology this element is contained in.</div> </td> </tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/iotp/IotpDevice.html#toString--">toString</a></span>()</code> </td> +</tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> @@ -294,8 +355,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <h4>IotpDevice</h4> <pre>public IotpDevice(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.util.Properties options)</pre> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service with the device - specified by <code>options</code>. +<div class="block">Create a connector for the IoT device specified by <code>options</code>. <BR> These properties must be set in <code>options</code>. @@ -319,10 +379,12 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht IotDevice iotDevice = new IotpDevice(options); </code> </pre> - <p> Connecting to the server occurs when the topology is submitted for execution. + </p> + <p> + See the IBM Watson IoT Platform documentation for additional properties. </p></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -334,14 +396,12 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <a name="IotpDevice-org.apache.edgent.topology.Topology-java.io.File-"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>IotpDevice</h4> <pre>public IotpDevice(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, java.io.File optionsFile)</pre> -<div class="block">Create a connector to the IBM Watson IoT Platform Bluemix service. - Device identifier and authorization are specified - by a configuration file. +<div class="block">Create a connector for the IoT device specified by <code>optionsFile</code>. <BR> The format of the file is: <pre> @@ -368,6 +428,9 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <p> Connecting to the server occurs when the topology is submitted for execution. + </p> + <p> + See the IBM Watson IoT Platform documentation for additional properties. </p></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -376,6 +439,22 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </dl> </li> </ul> +<a name="IotpDevice-org.apache.edgent.topology.Topology-com.ibm.iotf.client.device.DeviceClient-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>IotpDevice</h4> +<pre>public IotpDevice(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, + com.ibm.iotf.client.device.DeviceClient deviceClient)</pre> +<div class="block">Create a connector using the supplied WIoTP <code>DeviceClient</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>topology</code> - the connector's associated <code>Topology</code>.</dd> +<dd><code>deviceClient</code> - a WIoTP device client API object.</dd> +</dl> +</li> +</ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> @@ -466,6 +545,52 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </dl> </li> </ul> +<a name="httpEvents-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>httpEvents</h4> +<pre>public <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> httpEvents(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.String> eventId, + <a href="../../../../../org/apache/edgent/function/UnaryOperator.html" title="interface in org.apache.edgent.function">UnaryOperator</a><com.google.gson.JsonObject> payload)</pre> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol. + <p> + Each tuple is published as a device event with the supplied functions + providing the event identifier and payload from the tuple. + The event identifier and payload can be generated based upon the tuple. + The event is published with the equivalent of <a href="../../../../../org/apache/edgent/connectors/iot/QoS.html#AT_MOST_ONCE"><code>QoS.AT_MOST_ONCE</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream to be published.</dd> +<dd><code>eventId</code> - function to supply the event identifier.</dd> +<dd><code>payload</code> - function to supply the event's payload.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>TSink sink element representing termination of this stream.</dd> +</dl> +</li> +</ul> +<a name="httpEvents-org.apache.edgent.topology.TStream-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>httpEvents</h4> +<pre>public <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> httpEvents(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> stream, + java.lang.String eventId)</pre> +<div class="block">Publish a stream's tuples as device events using the WIoTP HTTP protocol. + <p> + Each tuple is published as a device event with the fixed event identifier. + The event is published with the equivalent of <a href="../../../../../org/apache/edgent/connectors/iot/QoS.html#AT_MOST_ONCE"><code>QoS.AT_MOST_ONCE</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stream</code> - Stream to be published.</dd> +<dd><code>eventId</code> - Event identifier.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>TSink sink element representing termination of this stream.</dd> +</dl> +</li> +</ul> <a name="commands-java.lang.String...-"> <!-- --> </a> @@ -502,7 +627,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <a name="topology--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>topology</h4> <pre>public <a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology()</pre> @@ -516,6 +641,53 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht </dl> </li> </ul> +<a name="getDeviceType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeviceType</h4> +<pre>public java.lang.String getDeviceType()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceType--">IotDevice</a></code></span></div> +<div class="block">Get the device's opaque device type identifier.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceType--">getDeviceType</a></code> in interface <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the device's type</dd> +</dl> +</li> +</ul> +<a name="getDeviceId--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDeviceId</h4> +<pre>public java.lang.String getDeviceId()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--">IotDevice</a></code></span></div> +<div class="block">Get the device's unique opaque device identifier.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html#getDeviceId--">getDeviceId</a></code> in interface <code><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the device's id</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> </li> </ul> </li> @@ -546,7 +718,7 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <div class="subNav"> <ul class="navList"> <li>Prev Class</li> -<li>Next Class</li> +<li><a href="../../../../../org/apache/edgent/connectors/iotp/IotpGateway.html" title="class in org.apache.edgent.connectors.iotp"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/edgent/connectors/iotp/IotpDevice.html" target="_top">Frames</a></li> @@ -586,6 +758,6 @@ implements <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.ht <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2016 The Apache Software Foundation. All Rights Reserved - 73539fa-20161119-2136</small></p> +<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p> </body> </html>