You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by dl...@apache.org on 2017/12/18 19:37:00 UTC
[31/52] [partial] incubator-edgent-website git commit: fix adding
release 1.2.0 javadoc
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/1d74f4c0/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttConfig.html
----------------------------------------------------------------------
diff --git a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttConfig.html b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttConfig.html
index 3ee8de6..4830483 100644
--- a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttConfig.html
+++ b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttConfig.html
@@ -2,9 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 -->
-<title>MqttConfig (Edgent v1.1.0)</title>
-<meta name="date" content="2017-02-26">
+<!-- Generated by javadoc (1.8.0_112) on Mon Dec 18 11:25:21 EST 2017 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>MqttConfig (Apache Edgent (incubating) v1.2.0 API)</title>
+<meta name="date" content="2017-12-18">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
@@ -12,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="MqttConfig (Edgent v1.1.0)";
+ parent.document.title="MqttConfig (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
@@ -97,7 +98,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
-<li>java.lang.Object</li>
+<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.edgent.connectors.mqtt.MqttConfig</li>
@@ -110,7 +111,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public class <span class="typeNameLabel">MqttConfig</span>
-extends java.lang.Object</pre>
+extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">MQTT broker connector configuration.</div>
</li>
</ul>
@@ -135,8 +136,8 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr class="rowColor">
-<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#MqttConfig-java.lang.String-java.lang.String-">MqttConfig</a></span>(java.lang.String serverURL,
- java.lang.String clientId)</code>
+<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#MqttConfig-java.lang.String-java.lang.String-">MqttConfig</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> serverURL,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</code>
<div class="block">Create a new configuration.</div>
</td>
</tr>
@@ -157,8 +158,8 @@ extends java.lang.Object</pre>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">MqttConfig</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#fromProperties-java.util.Properties-">fromProperties</a></span>(java.util.Properties properties)</code>
-<div class="block">Create a new configuration from <code>Properties</code>.</div>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#fromProperties-java.util.Properties-">fromProperties</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</code>
+<div class="block">Create a new configuration from <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
@@ -168,7 +169,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i2" class="altColor">
-<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#getClientId--">getClientId</a></span>()</code>
<div class="block">Get the connection Client Id.</div>
</td>
@@ -192,7 +193,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i6" class="altColor">
-<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#getKeyStore--">getKeyStore</a></span>()</code>
<div class="block">Get the SSL trust store path.</div>
</td>
@@ -216,7 +217,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i10" class="altColor">
-<td class="colFirst"><code>java.lang.String[]</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#getServerURLs--">getServerURLs</a></span>()</code>
<div class="block">Get the MQTT Server URLs</div>
</td>
@@ -228,7 +229,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i12" class="altColor">
-<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#getTrustStore--">getTrustStore</a></span>()</code>
<div class="block">Get the SSL trust store path.</div>
</td>
@@ -240,13 +241,13 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i14" class="altColor">
-<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#getUserName--">getUserName</a></span>()</code>
<div class="block">Get the username to use for authentication with the server.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
-<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#getWillDestination--">getWillDestination</a></span>()</code>
<div class="block">Get a Last Will and Testament message's destination topic.</div>
</td>
@@ -276,7 +277,7 @@ extends java.lang.Object</pre>
</td>
</tr>
<tr id="i20" class="altColor">
-<td class="colFirst"><code>java.lang.Object</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#options--">options</a></span>()</code>
<div class="block">INTERNAL USE ONLY.</div>
</td>
@@ -295,7 +296,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setClientId-java.lang.String-">setClientId</a></span>(java.lang.String clientId)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setClientId-java.lang.String-">setClientId</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</code>
<div class="block">Connection Client Id.</div>
</td>
</tr>
@@ -319,7 +320,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setKeyStore-java.lang.String-">setKeyStore</a></span>(java.lang.String path)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setKeyStore-java.lang.String-">setKeyStore</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code>
<div class="block">Set the SSL key store path.</div>
</td>
</tr>
@@ -343,7 +344,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setServerURLs-java.lang.String:A-">setServerURLs</a></span>(java.lang.String[] serverUrls)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setServerURLs-java.lang.String:A-">setServerURLs</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] serverUrls)</code>
<div class="block">MQTT Server URLs</div>
</td>
</tr>
@@ -355,7 +356,7 @@ extends java.lang.Object</pre>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setTrustStore-java.lang.String-">setTrustStore</a></span>(java.lang.String path)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setTrustStore-java.lang.String-">setTrustStore</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code>
<div class="block">Set the SSL trust store path.</div>
</td>
</tr>
@@ -367,13 +368,13 @@ extends java.lang.Object</pre>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setUserName-java.lang.String-">setUserName</a></span>(java.lang.String userName)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setUserName-java.lang.String-">setUserName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName)</code>
<div class="block">Set the username to use for authentication with the server.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setWill-java.lang.String-byte:A-int-boolean-">setWill</a></span>(java.lang.String topic,
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#setWill-java.lang.String-byte:A-int-boolean-">setWill</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic,
byte[] payload,
int qos,
boolean retained)</code>
@@ -385,8 +386,8 @@ extends java.lang.Object</pre>
<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>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -418,8 +419,8 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>MqttConfig</h4>
-<pre>public MqttConfig(java.lang.String serverURL,
- java.lang.String clientId)</pre>
+<pre>public MqttConfig(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> serverURL,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</pre>
<div class="block">Create a new configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -442,8 +443,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>fromProperties</h4>
-<pre>public static <a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">MqttConfig</a> fromProperties(java.util.Properties properties)</pre>
-<div class="block">Create a new configuration from <code>Properties</code>.
+<pre>public static <a href="../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">MqttConfig</a> fromProperties(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</pre>
+<div class="block">Create a new configuration from <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a>.
<p>
There is a property corresponding to each <code>MqttConfig.set<name>()</code>
method. Unless otherwise stated, the property's value is a string
@@ -498,7 +499,7 @@ extends java.lang.Object</pre>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configuration</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code>java.lang.IllegalArgumentException</code> - for illegal values</dd>
+<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - for illegal values</dd>
</dl>
</li>
</ul>
@@ -508,7 +509,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getClientId</h4>
-<pre>public java.lang.String getClientId()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getClientId()</pre>
<div class="block">Get the connection Client Id.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -606,7 +607,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getServerURLs</h4>
-<pre>public java.lang.String[] getServerURLs()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] getServerURLs()</pre>
<div class="block">Get the MQTT Server URLs</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -620,7 +621,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getWillDestination</h4>
-<pre>public java.lang.String getWillDestination()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getWillDestination()</pre>
<div class="block">Get a Last Will and Testament message's destination topic.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -704,7 +705,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getUserName</h4>
-<pre>public java.lang.String getUserName()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getUserName()</pre>
<div class="block">Get the username to use for authentication with the server.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -718,7 +719,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setClientId</h4>
-<pre>public void setClientId(java.lang.String clientId)</pre>
+<pre>public void setClientId(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</pre>
<div class="block">Connection Client Id.
<p>
Optional. default null: a clientId is auto-generated.</div>
@@ -854,7 +855,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setServerURLs</h4>
-<pre>public void setServerURLs(java.lang.String[] serverUrls)</pre>
+<pre>public void setServerURLs(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] serverUrls)</pre>
<div class="block">MQTT Server URLs
<p>
Required. Must be an array of one or more MQTT server URLs.
@@ -871,7 +872,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setWill</h4>
-<pre>public void setWill(java.lang.String topic,
+<pre>public void setWill(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic,
byte[] payload,
int qos,
boolean retained)</pre>
@@ -908,7 +909,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setUserName</h4>
-<pre>public void setUserName(java.lang.String userName)</pre>
+<pre>public void setUserName(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName)</pre>
<div class="block">Set the username to use for authentication with the server.
Optional. default: null.</div>
<dl>
@@ -923,7 +924,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setTrustStore</h4>
-<pre>public void setTrustStore(java.lang.String path)</pre>
+<pre>public void setTrustStore(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre>
<div class="block">Set the SSL trust store path.
<p>
Only used with "ssl:" serverURL.
@@ -943,7 +944,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getTrustStore</h4>
-<pre>public java.lang.String getTrustStore()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getTrustStore()</pre>
<div class="block">Get the SSL trust store path.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -987,7 +988,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>setKeyStore</h4>
-<pre>public void setKeyStore(java.lang.String path)</pre>
+<pre>public void setKeyStore(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre>
<div class="block">Set the SSL key store path.
<p>
Only used with "ssl:" serverURL when the server is configured for
@@ -1007,7 +1008,7 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>getKeyStore</h4>
-<pre>public java.lang.String getKeyStore()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getKeyStore()</pre>
<div class="block">Get the SSL trust store path.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1051,7 +1052,7 @@ extends java.lang.Object</pre>
<ul class="blockListLast">
<li class="blockList">
<h4>options</h4>
-<pre>public java.lang.Object options()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> options()</pre>
<div class="block">INTERNAL USE ONLY.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
@@ -1084,7 +1085,6 @@ extends java.lang.Object</pre>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
-<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -1129,6 +1129,6 @@ extends java.lang.Object</pre>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p>
+<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/1d74f4c0/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttStreams.html
----------------------------------------------------------------------
diff --git a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttStreams.html b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttStreams.html
index d999be4..41a1eb9 100644
--- a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttStreams.html
+++ b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/MqttStreams.html
@@ -2,9 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:10 EST 2017 -->
-<title>MqttStreams (Edgent v1.1.0)</title>
-<meta name="date" content="2017-02-26">
+<!-- Generated by javadoc (1.8.0_112) on Mon Dec 18 11:25:21 EST 2017 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>MqttStreams (Apache Edgent (incubating) v1.2.0 API)</title>
+<meta name="date" content="2017-12-18">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
@@ -12,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="MqttStreams (Edgent v1.1.0)";
+ parent.document.title="MqttStreams (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
@@ -97,7 +98,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
-<li>java.lang.Object</li>
+<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.edgent.connectors.mqtt.MqttStreams</li>
@@ -110,7 +111,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public class <span class="typeNameLabel">MqttStreams</span>
-extends java.lang.Object</pre>
+extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><code>MqttStreams</code> is a connector to a MQTT messaging broker
for publishing and subscribing to topics.
<p>
@@ -191,8 +192,8 @@ extends java.lang.Object</pre>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#MqttStreams-org.apache.edgent.topology.Topology-java.lang.String-java.lang.String-">MqttStreams</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology,
- java.lang.String url,
- java.lang.String clientId)</code>
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> url,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</code>
<div class="block">Create a connector to the specified server.</div>
</td>
</tr>
@@ -218,9 +219,9 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
-<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#publish-org.apache.edgent.topology.TStream-java.lang.String-int-boolean-">publish</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> stream,
- java.lang.String topic,
+<td class="colFirst"><code><a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#publish-org.apache.edgent.topology.TStream-java.lang.String-int-boolean-">publish</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> stream,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic,
int qos,
boolean retain)</code>
<div class="block">Publish a <code>TStream<String></code> stream's tuples as MQTT messages.</div>
@@ -229,25 +230,25 @@ extends java.lang.Object</pre>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><T></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#publish-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.Function-org.apache.edgent.function.Function-org.apache.edgent.function.Function-">publish</a></span>(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream,
- <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,java.lang.String> topic,
+ <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> topic,
<a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,byte[]> payload,
- <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,java.lang.Integer> qos,
- <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,java.lang.Boolean> retain)</code>
+ <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> qos,
+ <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>> retain)</code>
<div class="block">Publish a stream's tuples as MQTT messages.</div>
</td>
</tr>
<tr id="i2" class="altColor">
-<td class="colFirst"><code><T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#subscribe-java.lang.String-int-">subscribe</a></span>(java.lang.String topicFilter,
+<td class="colFirst"><code><T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#subscribe-java.lang.String-int-">subscribe</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topicFilter,
int qos)</code>
<div class="block">Subscribe to the MQTT topic(s) and create a <code>TStream<String></code>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#subscribe-java.lang.String-int-org.apache.edgent.function.BiFunction-">subscribe</a></span>(java.lang.String topicFilter,
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html#subscribe-java.lang.String-int-org.apache.edgent.function.BiFunction-">subscribe</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topicFilter,
int qos,
- <a href="../../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><java.lang.String,byte[],T> message2Tuple)</code>
+ <a href="../../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,byte[],T> message2Tuple)</code>
<div class="block">Subscribe to the MQTT topic(s) and create a stream of tuples of type <code>T</code>.</div>
</td>
</tr>
@@ -262,8 +263,8 @@ extends java.lang.Object</pre>
<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>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -286,8 +287,8 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>MqttStreams</h4>
<pre>public MqttStreams(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology,
- java.lang.String url,
- java.lang.String clientId)</pre>
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> url,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> clientId)</pre>
<div class="block">Create a connector to the specified server.
<p>
A convenience function.
@@ -335,10 +336,10 @@ extends java.lang.Object</pre>
<li class="blockList">
<h4>publish</h4>
<pre>public <T> <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><T> publish(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> stream,
- <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,java.lang.String> topic,
+ <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> topic,
<a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,byte[]> payload,
- <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,java.lang.Integer> qos,
- <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,java.lang.Boolean> retain)</pre>
+ <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> qos,
+ <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>> retain)</pre>
<div class="block">Publish a stream's tuples as MQTT messages.
<p>Each tuple is published as an MQTT message with
the supplied functions providing the message topic, payload
@@ -363,10 +364,10 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>publish</h4>
-<pre>public <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><java.lang.String> publish(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> stream,
- java.lang.String topic,
- int qos,
- boolean retain)</pre>
+<pre>public <a href="../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> publish(<a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> stream,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topic,
+ int qos,
+ boolean retain)</pre>
<div class="block">Publish a <code>TStream<String></code> stream's tuples as MQTT messages.
<p>
A convenience function.
@@ -388,9 +389,9 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>subscribe</h4>
-<pre>public <T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> subscribe(java.lang.String topicFilter,
+<pre>public <T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><T> subscribe(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topicFilter,
int qos,
- <a href="../../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><java.lang.String,byte[],T> message2Tuple)</pre>
+ <a href="../../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,byte[],T> message2Tuple)</pre>
<div class="block">Subscribe to the MQTT topic(s) and create a stream of tuples of type <code>T</code>.</div>
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
@@ -411,8 +412,8 @@ extends java.lang.Object</pre>
<ul class="blockList">
<li class="blockList">
<h4>subscribe</h4>
-<pre>public <T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><java.lang.String> subscribe(java.lang.String topicFilter,
- int qos)</pre>
+<pre>public <T> <a href="../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> subscribe(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> topicFilter,
+ int qos)</pre>
<div class="block">Subscribe to the MQTT topic(s) and create a <code>TStream<String></code>.
<p>
A convenience function.
@@ -470,7 +471,6 @@ extends java.lang.Object</pre>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
-<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -515,6 +515,6 @@ extends java.lang.Object</pre>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p>
+<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/1d74f4c0/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttConfig.html
----------------------------------------------------------------------
diff --git a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttConfig.html b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttConfig.html
index bd49803..97c3578 100644
--- a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttConfig.html
+++ b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttConfig.html
@@ -2,9 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 -->
-<title>Uses of Class org.apache.edgent.connectors.mqtt.MqttConfig (Edgent v1.1.0)</title>
-<meta name="date" content="2017-02-26">
+<!-- Generated by javadoc (1.8.0_112) on Mon Dec 18 11:25:23 EST 2017 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Uses of Class org.apache.edgent.connectors.mqtt.MqttConfig (Apache Edgent (incubating) v1.2.0 API)</title>
+<meta name="date" content="2017-12-18">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
@@ -12,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Uses of Class org.apache.edgent.connectors.mqtt.MqttConfig (Edgent v1.1.0)";
+ parent.document.title="Uses of Class org.apache.edgent.connectors.mqtt.MqttConfig (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
@@ -35,7 +36,7 @@
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">Class</a></li>
<li class="navBarCell1Rev">Use</li>
-<li><a href="../../../../../../overview-tree.html">Tree</a></li>
+<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
@@ -112,8 +113,8 @@
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">MqttConfig</a></code></td>
-<td class="colLast"><span class="typeNameLabel">MqttConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#fromProperties-java.util.Properties-">fromProperties</a></span>(java.util.Properties properties)</code>
-<div class="block">Create a new configuration from <code>Properties</code>.</div>
+<td class="colLast"><span class="typeNameLabel">MqttConfig.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html#fromProperties-java.util.Properties-">fromProperties</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</code>
+<div class="block">Create a new configuration from <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util"><code>Properties</code></a>.</div>
</td>
</tr>
</tbody>
@@ -160,7 +161,7 @@
<tbody>
<tr class="altColor">
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#MqttDevice-org.apache.edgent.topology.Topology-java.util.Properties-org.apache.edgent.connectors.mqtt.MqttConfig-">MqttDevice</a></span>(<a href="../../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology,
- java.util.Properties properties,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties,
<a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">MqttConfig</a> mqttConfig)</code>
<div class="block">Create an MqttDevice connector.</div>
</td>
@@ -185,12 +186,11 @@
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">Class</a></li>
<li class="navBarCell1Rev">Use</li>
-<li><a href="../../../../../../overview-tree.html">Tree</a></li>
+<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
-<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -220,6 +220,6 @@
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p>
+<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/1d74f4c0/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttStreams.html
----------------------------------------------------------------------
diff --git a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttStreams.html b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttStreams.html
index bc96551..33ca665 100644
--- a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttStreams.html
+++ b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/class-use/MqttStreams.html
@@ -2,9 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 -->
-<title>Uses of Class org.apache.edgent.connectors.mqtt.MqttStreams (Edgent v1.1.0)</title>
-<meta name="date" content="2017-02-26">
+<!-- Generated by javadoc (1.8.0_112) on Mon Dec 18 11:25:23 EST 2017 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Uses of Class org.apache.edgent.connectors.mqtt.MqttStreams (Apache Edgent (incubating) v1.2.0 API)</title>
+<meta name="date" content="2017-12-18">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
@@ -12,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Uses of Class org.apache.edgent.connectors.mqtt.MqttStreams (Edgent v1.1.0)";
+ parent.document.title="Uses of Class org.apache.edgent.connectors.mqtt.MqttStreams (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
@@ -35,7 +36,7 @@
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html" title="class in org.apache.edgent.connectors.mqtt">Class</a></li>
<li class="navBarCell1Rev">Use</li>
-<li><a href="../../../../../../overview-tree.html">Tree</a></li>
+<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
@@ -86,12 +87,11 @@
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html" title="class in org.apache.edgent.connectors.mqtt">Class</a></li>
<li class="navBarCell1Rev">Use</li>
-<li><a href="../../../../../../overview-tree.html">Tree</a></li>
+<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
-<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -121,6 +121,6 @@
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p>
+<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/1d74f4c0/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/MqttDevice.html
----------------------------------------------------------------------
diff --git a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/MqttDevice.html b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/MqttDevice.html
index 24b6dda..3ecc4ff 100644
--- a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/MqttDevice.html
+++ b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/MqttDevice.html
@@ -2,9 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:09 EST 2017 -->
-<title>MqttDevice (Edgent v1.1.0)</title>
-<meta name="date" content="2017-02-26">
+<!-- Generated by javadoc (1.8.0_112) on Mon Dec 18 11:25:21 EST 2017 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>MqttDevice (Apache Edgent (incubating) v1.2.0 API)</title>
+<meta name="date" content="2017-12-18">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
</head>
@@ -12,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="MqttDevice (Edgent v1.1.0)";
+ parent.document.title="MqttDevice (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
@@ -97,7 +98,7 @@ var activeTableTab = "activeTableTab";
</div>
<div class="contentContainer">
<ul class="inheritance">
-<li>java.lang.Object</li>
+<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.edgent.connectors.mqtt.iot.MqttDevice</li>
@@ -114,7 +115,7 @@ var activeTableTab = "activeTableTab";
<hr>
<br>
<pre>public class <span class="typeNameLabel">MqttDevice</span>
-extends java.lang.Object
+extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a></pre>
<div class="block">An MQTT based Edgent <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><code>IotDevice</code></a> connector.
<p>
@@ -122,9 +123,16 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
the <a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttStreams.html" title="class in org.apache.edgent.connectors.mqtt"><code>MqttStreams</code></a> connector.
<p>
The connector doesn't presume a particular pattern for
- Device MQTT "event" topic and "command" topics though default
+ Device MQTT "event" and "command" topics though default
patterns are provided.
<p>
+ The MQTT message content for device events and device commands must be JSON.
+ The contents of the JSON are under the control of the collaborating MQTT clients.
+ Typically a device to defines its event and command schemas
+ and the other clients to adapt accordingly.
+ See <a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#commands-java.lang.String...-"><code>commands(String...)</code></a> and <a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-"><code>events()</code></a>
+ for a description of how MQTT messages are converted to and from stream tuples.
+ <p>
Connector configuration Properties fall into two categories:
<ul>
<li>MQTT Device abstraction properties</li>
@@ -210,13 +218,13 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#MqttDevice-org.apache.edgent.topology.Topology-java.util.Properties-">MqttDevice</a></span>(<a href="../../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology,
- java.util.Properties properties)</code>
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</code>
<div class="block">Create an MqttDevice connector.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#MqttDevice-org.apache.edgent.topology.Topology-java.util.Properties-org.apache.edgent.connectors.mqtt.MqttConfig-">MqttDevice</a></span>(<a href="../../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology,
- java.util.Properties properties,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties,
<a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">MqttConfig</a> mqttConfig)</code>
<div class="block">Create an MqttDevice connector.</div>
</td>
@@ -238,47 +246,47 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#commands-java.lang.String...-">commands</a></span>(java.lang.String... commands)</code>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#commands-java.lang.String...-">commands</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... commands)</code>
<div class="block">Create a stream of device commands as JSON objects.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
-<td class="colFirst"><code>java.lang.String</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#commandTopic-java.lang.String-">commandTopic</a></span>(java.lang.String command)</code>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#commandTopic-java.lang.String-">commandTopic</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command)</code>
<div class="block">Get the MQTT topic for a command.</div>
</td>
</tr>
<tr id="i2" 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/mqtt/iot/MqttDevice.html#events-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-">events</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/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> eventId,
<a href="../../../../../../org/apache/edgent/function/UnaryOperator.html" title="interface in org.apache.edgent.function">UnaryOperator</a><com.google.gson.JsonObject> payload,
- <a href="../../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.Integer> qos)</code>
+ <a href="../../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> qos)</code>
<div class="block">Publish a stream's tuples as device events.</div>
</td>
</tr>
<tr id="i3" 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/mqtt/iot/MqttDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-">events</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,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> eventId,
int qos)</code>
<div class="block">Publish a stream's tuples as device events.</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/mqtt/iot/MqttDevice.html#eventTopic-java.lang.String-">eventTopic</a></span>(java.lang.String eventId)</code>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#eventTopic-java.lang.String-">eventTopic</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> eventId)</code>
<div class="block">Get the MQTT topic for an device event.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
-<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#getDeviceId--">getDeviceId</a></span>()</code>
<div class="block">Get the device's unique opaque device identifier.</div>
</td>
</tr>
<tr id="i6" class="altColor">
-<td class="colFirst"><code>java.lang.String</code></td>
+<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html#getDeviceType--">getDeviceType</a></span>()</code>
<div class="block">Get the device's opaque device type identifier.</div>
</td>
@@ -300,8 +308,8 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<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>
+<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -324,7 +332,7 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<li class="blockList">
<h4>MqttDevice</h4>
<pre>public MqttDevice(<a href="../../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology,
- java.util.Properties properties)</pre>
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties)</pre>
<div class="block">Create an MqttDevice connector.
<p>
All configuration information comes from <code>properties</code>.</div>
@@ -342,7 +350,7 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<li class="blockList">
<h4>MqttDevice</h4>
<pre>public MqttDevice(<a href="../../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology,
- java.util.Properties properties,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a> properties,
<a href="../../../../../../org/apache/edgent/connectors/mqtt/MqttConfig.html" title="class in org.apache.edgent.connectors.mqtt">MqttConfig</a> mqttConfig)</pre>
<div class="block">Create an MqttDevice connector.
<p>
@@ -371,7 +379,7 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<ul class="blockList">
<li class="blockList">
<h4>eventTopic</h4>
-<pre>public java.lang.String eventTopic(java.lang.String eventId)</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> eventTopic(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> eventId)</pre>
<div class="block">Get the MQTT topic for an device event.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -388,7 +396,7 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<ul class="blockList">
<li class="blockList">
<h4>commandTopic</h4>
-<pre>public java.lang.String commandTopic(java.lang.String command)</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> commandTopic(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> command)</pre>
<div class="block">Get the MQTT topic for a command.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -420,15 +428,20 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<li class="blockList">
<h4>events</h4>
<pre>public <a href="../../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> events(<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/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> eventId,
<a href="../../../../../../org/apache/edgent/function/UnaryOperator.html" title="interface in org.apache.edgent.function">UnaryOperator</a><com.google.gson.JsonObject> payload,
- <a href="../../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,java.lang.Integer> qos)</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-">IotDevice</a></code></span></div>
+ <a href="../../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><com.google.gson.JsonObject,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> qos)</pre>
<div class="block">Publish a stream's tuples as device events.
<p>
Each tuple is published as a device event with the supplied functions
providing the event identifier, payload and QoS. The event identifier and
- QoS can be generated based upon the tuple.</div>
+ QoS can be generated based upon the tuple.
+
+ <p>The event is published to the configured MQTT <code>mqttDevice.event.topic.pattern</code>,
+ as described in the above class documentation, substituting the value returned
+ by the <code>eventId</code> function for "{EVENTID}" in the pattern.
+ The MQTT message's payload is the JSON representation
+ of the JsonObject stream tuple.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-org.apache.edgent.function.Function-org.apache.edgent.function.UnaryOperator-org.apache.edgent.function.Function-">events</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>
@@ -449,13 +462,18 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<li class="blockList">
<h4>events</h4>
<pre>public <a href="../../../../../../org/apache/edgent/topology/TSink.html" title="interface in org.apache.edgent.topology">TSink</a><com.google.gson.JsonObject> events(<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,
+ <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> eventId,
int qos)</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-">IotDevice</a></code></span></div>
<div class="block">Publish a stream's tuples as device events.
<p>
Each tuple is published as a device event with fixed event identifier and
- QoS.</div>
+ QoS.
+
+ <p>The event is published to the configured MQTT <code>mqttDevice.event.topic.pattern</code>,
+ as described in the above class documentation, substituting the <code>eventId</code> for
+ "{EVENTID}" in the pattern.
+ The MQTT message's payload is the JSON representation
+ of the JsonObject stream tuple.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html#events-org.apache.edgent.topology.TStream-java.lang.String-int-">events</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>
@@ -474,8 +492,7 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<ul class="blockList">
<li class="blockList">
<h4>commands</h4>
-<pre>public <a href="../../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> commands(java.lang.String... commands)</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html#commands-java.lang.String...-">IotDevice</a></code></span></div>
+<pre>public <a href="../../../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><com.google.gson.JsonObject> commands(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... commands)</pre>
<div class="block">Create a stream of device commands as JSON objects.
Each command sent to the device matching <code>commands</code> will result in a tuple
on the stream. The JSON object has these keys:
@@ -490,7 +507,14 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<LI>Otherwise <code>payload</code> is String</LI>
</UL>
</LI>
- </UL></div>
+ </UL>
+
+ <p>
+ Subscribes to the configured MQTT <code>mqttDevice.command.topic.pattern</code>
+ as described in the above class documentation.
+ The received MQTT message's payload is required to be JSON.
+ The message's JSON payload is converted to a JsonObject and
+ set as the <code>payload</code> key's value in the stream tuple JsonObject.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice.html#commands-java.lang.String...-">commands</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>
@@ -525,7 +549,7 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<ul class="blockList">
<li class="blockList">
<h4>getDeviceType</h4>
-<pre>public java.lang.String getDeviceType()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getDeviceType()</pre>
<div class="block">Get the device's opaque device type identifier.
<p>
This connector does not support the notion of a device-type
@@ -544,7 +568,7 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<ul class="blockListLast">
<li class="blockList">
<h4>getDeviceId</h4>
-<pre>public java.lang.String getDeviceId()</pre>
+<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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>
@@ -580,7 +604,6 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
-<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -625,6 +648,6 @@ implements <a href="../../../../../../org/apache/edgent/connectors/iot/IotDevice
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p>
+<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/1d74f4c0/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/class-use/MqttDevice.html
----------------------------------------------------------------------
diff --git a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/class-use/MqttDevice.html b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/class-use/MqttDevice.html
index 2a5bcc5..1dd1510 100644
--- a/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/class-use/MqttDevice.html
+++ b/site/javadoc/latest/org/apache/edgent/connectors/mqtt/iot/class-use/MqttDevice.html
@@ -2,9 +2,10 @@
<!-- NewPage -->
<html lang="en">
<head>
-<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:12 EST 2017 -->
-<title>Uses of Class org.apache.edgent.connectors.mqtt.iot.MqttDevice (Edgent v1.1.0)</title>
-<meta name="date" content="2017-02-26">
+<!-- Generated by javadoc (1.8.0_112) on Mon Dec 18 11:25:23 EST 2017 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Uses of Class org.apache.edgent.connectors.mqtt.iot.MqttDevice (Apache Edgent (incubating) v1.2.0 API)</title>
+<meta name="date" content="2017-12-18">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
</head>
@@ -12,7 +13,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Uses of Class org.apache.edgent.connectors.mqtt.iot.MqttDevice (Edgent v1.1.0)";
+ parent.document.title="Uses of Class org.apache.edgent.connectors.mqtt.iot.MqttDevice (Apache Edgent (incubating) v1.2.0 API)";
}
}
catch(err) {
@@ -35,7 +36,7 @@
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">Class</a></li>
<li class="navBarCell1Rev">Use</li>
-<li><a href="../../../../../../../overview-tree.html">Tree</a></li>
+<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
@@ -72,51 +73,7 @@
<div class="header">
<h2 title="Uses of Class org.apache.edgent.connectors.mqtt.iot.MqttDevice" class="title">Uses of Class<br>org.apache.edgent.connectors.mqtt.iot.MqttDevice</h2>
</div>
-<div class="classUseContainer">
-<ul class="blockList">
-<li class="blockList">
-<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
-<caption><span>Packages that use <a href="../../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">MqttDevice</a></span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Package</th>
-<th class="colLast" scope="col">Description</th>
-</tr>
-<tbody>
-<tr class="altColor">
-<td class="colFirst"><a href="#org.apache.edgent.samples.apps.mqtt">org.apache.edgent.samples.apps.mqtt</a></td>
-<td class="colLast">
-<div class="block">Base support for Edgent MQTT based application samples.</div>
-</td>
-</tr>
-</tbody>
-</table>
-</li>
-<li class="blockList">
-<ul class="blockList">
-<li class="blockList"><a name="org.apache.edgent.samples.apps.mqtt">
-<!-- -->
-</a>
-<h3>Uses of <a href="../../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">MqttDevice</a> in <a href="../../../../../../../org/apache/edgent/samples/apps/mqtt/package-summary.html">org.apache.edgent.samples.apps.mqtt</a></h3>
-<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
-<caption><span>Methods in <a href="../../../../../../../org/apache/edgent/samples/apps/mqtt/package-summary.html">org.apache.edgent.samples.apps.mqtt</a> that return <a href="../../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">MqttDevice</a></span><span class="tabEnd"> </span></caption>
-<tr>
-<th class="colFirst" scope="col">Modifier and Type</th>
-<th class="colLast" scope="col">Method and Description</th>
-</tr>
-<tbody>
-<tr class="altColor">
-<td class="colFirst"><code><a href="../../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">MqttDevice</a></code></td>
-<td class="colLast"><span class="typeNameLabel">AbstractMqttApplication.</span><code><span class="memberNameLink"><a href="../../../../../../../org/apache/edgent/samples/apps/mqtt/AbstractMqttApplication.html#mqttDevice--">mqttDevice</a></span>()</code>
-<div class="block">Get the application's MqttDevice</div>
-</td>
-</tr>
-</tbody>
-</table>
-</li>
-</ul>
-</li>
-</ul>
-</div>
+<div class="classUseContainer">No usage of org.apache.edgent.connectors.mqtt.iot.MqttDevice</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
@@ -130,12 +87,11 @@
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../../../../org/apache/edgent/connectors/mqtt/iot/MqttDevice.html" title="class in org.apache.edgent.connectors.mqtt.iot">Class</a></li>
<li class="navBarCell1Rev">Use</li>
-<li><a href="../../../../../../../overview-tree.html">Tree</a></li>
+<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
-<div class="aboutLanguage"><a href="http://edgent.incubator.apache.org">Apache Edgent (incubating)</a></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -165,6 +121,6 @@
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
-<p class="legalCopy"><small>Copyright © 2017 The Apache Software Foundation. All Rights Reserved - 4744f56-20170226-1707</small></p>
+<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>