http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/direct/package-tree.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/direct/package-tree.html b/site/javadoc/latest/org/apache/edgent/providers/direct/package-tree.html index 5e10a4a..a289b03 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/direct/package-tree.html +++ b/site/javadoc/latest/org/apache/edgent/providers/direct/package-tree.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>org.apache.edgent.providers.direct Class Hierarchy (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>org.apache.edgent.providers.direct Class Hierarchy (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="org.apache.edgent.providers.direct Class Hierarchy (Edgent v1.1.0)"; + parent.document.title="org.apache.edgent.providers.direct Class Hierarchy (Apache Edgent (incubating) v1.2.0 API)"; } } catch(err) { @@ -79,7 +80,7 @@ <div class="contentContainer"> <h2 title="Class Hierarchy">Class Hierarchy</h2> <ul> -<li type="circle">java.lang.Object +<li type="circle">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"><span class="typeNameLink">Object</span></a> <ul> <li type="circle">org.apache.edgent.topology.spi.<a href="../../../../../org/apache/edgent/topology/spi/AbstractTopology.html" title="class in org.apache.edgent.topology.spi"><span class="typeNameLink">AbstractTopology</span></a><X> (implements org.apache.edgent.topology.<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>) <ul> @@ -117,7 +118,6 @@ <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"> @@ -147,6 +147,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/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/direct/package-use.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/direct/package-use.html b/site/javadoc/latest/org/apache/edgent/providers/direct/package-use.html index a1c731a..838e790 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/direct/package-use.html +++ b/site/javadoc/latest/org/apache/edgent/providers/direct/package-use.html @@ -2,9 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:13 EST 2017 --> -<title>Uses of Package org.apache.edgent.providers.direct (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 Package org.apache.edgent.providers.direct (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 Package org.apache.edgent.providers.direct (Edgent v1.1.0)"; + parent.document.title="Uses of Package org.apache.edgent.providers.direct (Apache Edgent (incubating) v1.2.0 API)"; } } catch(err) { @@ -101,12 +102,6 @@ share an <code>IotDevice</code>.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><a href="#org.apache.edgent.samples.apps">org.apache.edgent.samples.apps</a></td> -<td class="colLast"> -<div class="block">Support for some more complex Edgent application samples.</div> -</td> -</tr> </tbody> </table> </li> @@ -166,25 +161,6 @@ </tbody> </table> </li> -<li class="blockList"><a name="org.apache.edgent.samples.apps"> -<!-- --> -</a> -<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../../org/apache/edgent/providers/direct/package-summary.html">org.apache.edgent.providers.direct</a> used by <a href="../../../../../org/apache/edgent/samples/apps/package-summary.html">org.apache.edgent.samples.apps</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../../org/apache/edgent/providers/direct/class-use/DirectProvider.html#org.apache.edgent.samples.apps">DirectProvider</a> -<div class="block"><code>DirectProvider</code> is a <a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology"><code>TopologyProvider</code></a> that - runs a submitted topology as a <a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution"><code>Job</code></a> in threads - in the current virtual machine.</div> -</td> -</tr> -</tbody> -</table> -</li> </ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> @@ -205,7 +181,6 @@ <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"> @@ -235,6 +210,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/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/iot/IotProvider.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/iot/IotProvider.html b/site/javadoc/latest/org/apache/edgent/providers/iot/IotProvider.html index e169c00..8d400ae 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/iot/IotProvider.html +++ b/site/javadoc/latest/org/apache/edgent/providers/iot/IotProvider.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>IotProvider (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>IotProvider (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="IotProvider (Edgent v1.1.0)"; + parent.document.title="IotProvider (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.providers.iot.IotProvider</li> @@ -114,40 +115,91 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public class <span class="typeNameLabel">IotProvider</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/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a>, <a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>></pre> -<div class="block">IoT provider supporting multiple topologies with a single connection to a - message hub. A provider that uses a single <a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><code>IotDevice</code></a> to communicate - with an IoT scale message hub. - <a href="../../../../../org/apache/edgent/connectors/pubsub/PublishSubscribe.html" title="class in org.apache.edgent.connectors.pubsub"><code>Publish-subscribe</code></a> is - used to allow multiple topologies to communicate through the single - connection. - <P> - This provider registers these services: +<div class="block">A provider that supports sharing of a single connection to an IoT message hub and + access to control MBeans via IoT device commands. + + <pre><code> + // sample use + class MyApp { + ... + public void run(String[] args) throws Exception { + IotProvider provider = new IotProvider((top) -> new IotpDevice(top, myDeviceConfig)); + provider.registerTopology("app1", (iotDevice, cfg) -> buildApp1(iotDevice, cfg)); + provider.start(); + } + private void buildApp1(IotDevice iotDevice, JsonConfig cfg) { + Topology top = iotDevice.getTopology(); + ... build the topology + } + } + </code></pre> + + <p>The registered builders are subsequently invoked from + <a href="../../../../../org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.html#submit-java.lang.String-java.lang.String-"><code>ApplicationServiceMXBean.submit()</code></a>. + Each builder invocation is given a virtual <code>IotDevice</code> for the topology's use. + Jobs can be stopped using their <a href="../../../../../org/apache/edgent/execution/mbeans/JobMXBean.html" title="interface in org.apache.edgent.execution.mbeans"><code>JobMXBean</code></a> control. + + <p>Applications may also be registered via + <a href="../../../../../org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.html#registerJar-java.lang.String-java.lang.String-"><code>registerJar()</code></a>. + See the note below regarding the <code>TopologyBuilder</code> for such applications. + + <p>Constructed topologies may also be submitted via + <a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#submit-org.apache.edgent.topology.Topology-com.google.gson.JsonObject-"><code>submit()</code></a> and are controllable + via their <code>JobMXBean</code>. + The <code>ApplicationService</code> is unaware of these topologies. + + <p>See the + <a href="../../../../../org/apache/edgent/providers/iot/package-summary.html">package documentation</a> + for details of using <a href="../../../../../org/apache/edgent/connectors/iot/Commands.html#CONTROL_SERVICE"><code>edgentControl</code></a> IoT device commands + to invoke methods on MBeans registered with the <code>ControlService</code>. + + <p>This provider registers these services: <UL> <LI><a href="../../../../../org/apache/edgent/execution/services/ControlService.html" title="interface in org.apache.edgent.execution.services"><code>control</code></a> - An instance of <a href="../../../../../org/apache/edgent/runtime/jsoncontrol/JsonControlService.html" title="class in org.apache.edgent.runtime.jsoncontrol"><code>JsonControlService</code></a>.</LI> <LI><a href="../../../../../org/apache/edgent/topology/services/ApplicationService.html" title="interface in org.apache.edgent.topology.services"><code>application</code></a> - An instance of <a href="../../../../../org/apache/edgent/runtime/appservice/AppService.html" title="class in org.apache.edgent.runtime.appservice"><code>AppService</code></a>.</LI> <LI><a href="../../../../../org/apache/edgent/connectors/pubsub/service/PublishSubscribeService.html" title="interface in org.apache.edgent.connectors.pubsub.service"><code>publish-subscribe</code></a> - An instance of <a href="../../../../../org/apache/edgent/connectors/pubsub/service/ProviderPubSub.html" title="class in org.apache.edgent.connectors.pubsub.service"><code>ProviderPubSub</code></a></LI> - <LI>preferences (optional) - An instance of <code>java.util.pref.Preferences</code> to store application + <LI><code>preferences</code> (optional) - An instance of <code>java.util.prefs.Preferences</code> to store application and service preferences. A <code>Preferences</code> node is created if the provider is created with a name that is not <code>null</code>. If the preferences implementation supports persistence then any preferences will be maintained across provider and JVM restarts when creating a provider with the same name. The <code>Preferences</code> node is a user node. </UL> - System applications provide this functionality: + + <p>System applications provide: <UL> <LI>Single connection to the message hub using an <code>IotDevice</code> using <a href="../../../../../org/apache/edgent/apps/iot/IotDevicePubSub.html" title="class in org.apache.edgent.apps.iot"><code>IotDevicePubSub</code></a>. Applications using this provider that want to connect to the message hub for device events and commands must create an instance of - <code>IotDevice</code> using <a href="../../../../../org/apache/edgent/apps/iot/IotDevicePubSub.html#addIotDevice-org.apache.edgent.topology.TopologyElement-"><code>IotDevicePubSub.addIotDevice(org.apache.edgent.topology.TopologyElement)</code></a></LI> - <LI>Access to the control service through device commands from the message hub using command - identifier <a href="../../../../../org/apache/edgent/connectors/iot/Commands.html#CONTROL_SERVICE"><code>edgentControl</code></a>. + <code>IotDevice</code> using <a href="../../../../../org/apache/edgent/apps/iot/IotDevicePubSub.html#addIotDevice-org.apache.edgent.topology.TopologyElement-"><code>addIotDevice()</code></a>. + See below for more information. + </LI> + <LI>Access to the control service through device commands from the message hub.</LI> </UL> - <P> - An <code>IotProvider</code> is created with a provider and submitter that it delegates - the creation and submission of topologies to. - </P></div> + + <p>If topology builders are registered with the ApplicationService using + something other than this provider's <code>registerTopology()</code>, + that code is responsible for creating the virtual IotDevice as described + above on each builder invocation. + + <p>For example, an application loaded and registered via + <a href="../../../../../org/apache/edgent/topology/services/ApplicationService.html#registerJar-java.lang.String-java.lang.String-"><code>ApplicationService.registerJar()</code></a> + would create the <code>IotDevice</code> for its builder in its + <a href="../../../../../org/apache/edgent/topology/services/TopologyBuilder.html#getBuilder--"><code>TopologyBuilder.getBuilder()</code></a> implementation: + <pre><code> + class MyApp implements TopologyBuilder { // be loadable by registerJar() + @Override + public BiConsumer<Topology t, JsonConfig c> getBuilder() { + return (t, c) -> buildTopology(IotDevicePubSub.addIotDevice(t), c); + } + private void buildTopology(IotDevice iotDevice, JsonConfig c) { + Topology t = iotDevice.getTopology(); + ... build your topology + } + } + </code></pre></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot"><code>IotDevice</code></a>, @@ -172,7 +224,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colFirst"><code>static <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/providers/iot/IotProvider.html#CONTROL_APP_NAME">CONTROL_APP_NAME</a></span></code> <div class="block">IoT control using device commands application name.</div> </td> @@ -197,20 +249,20 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#IotProvider-java.lang.String-org.apache.edgent.providers.direct.DirectProvider-org.apache.edgent.function.Function-">IotProvider</a></span>(java.lang.String name, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#IotProvider-java.lang.String-org.apache.edgent.providers.direct.DirectProvider-org.apache.edgent.function.Function-">IotProvider</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> name, <a href="../../../../../org/apache/edgent/providers/direct/DirectProvider.html" title="class in org.apache.edgent.providers.direct">DirectProvider</a> provider, <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>> iotDeviceCreator)</code> <div class="block">Create an <code>IotProvider</code> that uses the passed in <code>DirectProvider</code>.</div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#IotProvider-java.lang.String-org.apache.edgent.function.Function-">IotProvider</a></span>(java.lang.String name, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#IotProvider-java.lang.String-org.apache.edgent.function.Function-">IotProvider</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> name, <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>> iotDeviceCreator)</code> <div class="block">Create an <code>IotProvider</code> that uses its own <code>DirectProvider</code>.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#IotProvider-java.lang.String-org.apache.edgent.topology.TopologyProvider-org.apache.edgent.execution.DirectSubmitter-org.apache.edgent.function.Function-">IotProvider</a></span>(java.lang.String name, +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#IotProvider-java.lang.String-org.apache.edgent.topology.TopologyProvider-org.apache.edgent.execution.DirectSubmitter-org.apache.edgent.function.Function-">IotProvider</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> name, <a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a> provider, <a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submitter, <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>> iotDeviceCreator)</code> @@ -268,14 +320,14 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#getControlService--">getControlService</a></span>()</code> </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/providers/iot/IotProvider.html#getName--">getName</a></span>()</code> <div class="block">Return the name of this provider.</div> </td> </tr> <tr id="i7" class="rowColor"> -<td class="colFirst"><code>static java.util.prefs.Preferences</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#getPreferences-java.lang.String-">getPreferences</a></span>(java.lang.String providerName)</code> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/prefs/Preferences.html?is-external=true"; title="class or interface in java.util.prefs">Preferences</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#getPreferences-java.lang.String-">getPreferences</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> providerName)</code> <div class="block">Get the Preferences node that will be used for the IotProvider with the specified name.</div> </td> </tr> @@ -293,7 +345,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h </tr> <tr id="i10" 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/providers/iot/IotProvider.html#newTopology-java.lang.String-">newTopology</a></span>(java.lang.String name)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#newTopology-java.lang.String-">newTopology</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> name)</code> <div class="block">Create a new topology with a given name.</div> </td> </tr> @@ -315,14 +367,14 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h </tr> <tr id="i15" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-">registerTopology</a></span>(java.lang.String applicationName, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-">registerTopology</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> applicationName, <a href="../../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>,com.google.gson.JsonObject> builder)</code> <div class="block">Register an application that uses an <code>IotDevice</code>.</div> </td> </tr> <tr id="i16" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-boolean-com.google.gson.JsonObject-">registerTopology</a></span>(java.lang.String applicationName, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-boolean-com.google.gson.JsonObject-">registerTopology</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> applicationName, <a href="../../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>,com.google.gson.JsonObject> builder, boolean autoSubmit, com.google.gson.JsonObject config)</code> @@ -337,13 +389,13 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h </td> </tr> <tr id="i18" class="altColor"> -<td class="colFirst"><code>java.util.concurrent.Future<<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true"; title="class or interface in java.util.concurrent">Future</a><<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#submit-org.apache.edgent.topology.Topology-">submit</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology)</code> <div class="block">Submit an executable.</div> </td> </tr> <tr id="i19" class="rowColor"> -<td class="colFirst"><code>java.util.concurrent.Future<<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true"; title="class or interface in java.util.concurrent">Future</a><<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html#submit-org.apache.edgent.topology.Topology-com.google.gson.JsonObject-">submit</a></span>(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, com.google.gson.JsonObject config)</code> <div class="block">Submit an executable.</div> @@ -354,8 +406,8 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <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> @@ -377,7 +429,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockListLast"> <li class="blockList"> <h4>CONTROL_APP_NAME</h4> -<pre>public static final java.lang.String CONTROL_APP_NAME</pre> +<pre>public static final <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> CONTROL_APP_NAME</pre> <div class="block">IoT control using device commands application name.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -416,7 +468,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>IotProvider</h4> -<pre>public IotProvider(java.lang.String name, +<pre>public IotProvider(<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> name, <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>> iotDeviceCreator)</pre> <div class="block">Create an <code>IotProvider</code> that uses its own <code>DirectProvider</code>.</div> <dl> @@ -434,7 +486,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>IotProvider</h4> -<pre>public IotProvider(java.lang.String name, +<pre>public IotProvider(<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> name, <a href="../../../../../org/apache/edgent/providers/direct/DirectProvider.html" title="class in org.apache.edgent.providers.direct">DirectProvider</a> provider, <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>> iotDeviceCreator)</pre> <div class="block">Create an <code>IotProvider</code> that uses the passed in <code>DirectProvider</code>.</div> @@ -454,7 +506,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockListLast"> <li class="blockList"> <h4>IotProvider</h4> -<pre>public IotProvider(java.lang.String name, +<pre>public IotProvider(<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> name, <a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a> provider, <a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submitter, <a href="../../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>> iotDeviceCreator)</pre> @@ -482,7 +534,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>getName</h4> -<pre>public java.lang.String getName()</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> getName()</pre> <div class="block">Return the name of this provider.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -549,7 +601,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>newTopology</h4> -<pre>public final <a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> newTopology(java.lang.String name)</pre> +<pre>public final <a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> newTopology(<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> name)</pre> <div class="block">Create a new topology with a given name.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -567,7 +619,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>submit</h4> -<pre>public final java.util.concurrent.Future<<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submit(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology)</pre> +<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true"; title="class or interface in java.util.concurrent">Future</a><<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submit(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology)</pre> <div class="block">Submit an executable. No configuration options are specified, this is equivalent to <code>submit(executable, new JsonObject())</code>.</div> @@ -587,8 +639,8 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>submit</h4> -<pre>public final java.util.concurrent.Future<<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submit(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, - com.google.gson.JsonObject config)</pre> +<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/Future.html?is-external=true"; title="class or interface in java.util.concurrent">Future</a><<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submit(<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a> topology, + com.google.gson.JsonObject config)</pre> <div class="block">Submit an executable.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> @@ -643,7 +695,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>getPreferences</h4> -<pre>public static java.util.prefs.Preferences getPreferences(java.lang.String providerName)</pre> +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/prefs/Preferences.html?is-external=true"; title="class or interface in java.util.prefs">Preferences</a> getPreferences(<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> providerName)</pre> <div class="block">Get the Preferences node that will be used for the IotProvider with the specified name.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -716,12 +768,12 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <li class="blockList"> <h4>start</h4> <pre>public void start() - throws java.lang.Exception</pre> + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Start this provider by starting its system applications and any autoSubmit-enabled registered applications.</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.Exception</code> - on failure starting applications.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - on failure starting applications.</dd> </dl> </li> </ul> @@ -762,7 +814,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockList"> <li class="blockList"> <h4>registerTopology</h4> -<pre>public void registerTopology(java.lang.String applicationName, +<pre>public void registerTopology(<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> applicationName, <a href="../../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>,com.google.gson.JsonObject> builder)</pre> <div class="block">Register an application that uses an <code>IotDevice</code>. <BR> @@ -780,7 +832,7 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <ul class="blockListLast"> <li class="blockList"> <h4>registerTopology</h4> -<pre>public void registerTopology(java.lang.String applicationName, +<pre>public void registerTopology(<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> applicationName, <a href="../../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../../org/apache/edgent/connectors/iot/IotDevice.html" title="interface in org.apache.edgent.connectors.iot">IotDevice</a>,com.google.gson.JsonObject> builder, boolean autoSubmit, com.google.gson.JsonObject config)</pre> @@ -837,7 +889,6 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <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"> @@ -882,6 +933,6 @@ implements <a href="../../../../../org/apache/edgent/topology/TopologyProvider.h <!-- --> </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/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/iot/class-use/IotProvider.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/iot/class-use/IotProvider.html b/site/javadoc/latest/org/apache/edgent/providers/iot/class-use/IotProvider.html index cfde4ce..ab1f5e6 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/iot/class-use/IotProvider.html +++ b/site/javadoc/latest/org/apache/edgent/providers/iot/class-use/IotProvider.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.providers.iot.IotProvider (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.providers.iot.IotProvider (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.providers.iot.IotProvider (Edgent v1.1.0)"; + parent.document.title="Uses of Class org.apache.edgent.providers.iot.IotProvider (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/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.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,55 +73,7 @@ <div class="header"> <h2 title="Uses of Class org.apache.edgent.providers.iot.IotProvider" class="title">Uses of Class<br>org.apache.edgent.providers.iot.IotProvider</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/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</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.scenarios.iotp">org.apache.edgent.samples.scenarios.iotp</a></td> -<td class="colLast"> </td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"> -<ul class="blockList"> -<li class="blockList"><a name="org.apache.edgent.samples.scenarios.iotp"> -<!-- --> -</a> -<h3>Uses of <a href="../../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</a> in <a href="../../../../../../org/apache/edgent/samples/scenarios/iotp/package-summary.html">org.apache.edgent.samples.scenarios.iotp</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/scenarios/iotp/package-summary.html">org.apache.edgent.samples.scenarios.iotp</a> with parameters of type <a href="../../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</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>static void</code></td> -<td class="colLast"><span class="typeNameLabel">IotpFullScenario.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.html#registerDisplay-org.apache.edgent.providers.iot.IotProvider-">registerDisplay</a></span>(<a href="../../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</a> provider)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static void</code></td> -<td class="colLast"><span class="typeNameLabel">IotpFullScenario.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.html#registerHeartbeat-org.apache.edgent.providers.iot.IotProvider-">registerHeartbeat</a></span>(<a href="../../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</a> provider)</code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static void</code></td> -<td class="colLast"><span class="typeNameLabel">IotpFullScenario.</span><code><span class="memberNameLink"><a href="../../../../../../org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.html#registerSensors-org.apache.edgent.providers.iot.IotProvider-">registerSensors</a></span>(<a href="../../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</a> provider)</code> </td> -</tr> -</tbody> -</table> -</li> -</ul> -</li> -</ul> -</div> +<div class="classUseContainer">No usage of org.apache.edgent.providers.iot.IotProvider</div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> @@ -134,12 +87,11 @@ <li><a href="../package-summary.html">Package</a></li> <li><a href="../../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.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"> @@ -169,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/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/iot/package-frame.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/iot/package-frame.html b/site/javadoc/latest/org/apache/edgent/providers/iot/package-frame.html index d028b14..436126e 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/iot/package-frame.html +++ b/site/javadoc/latest/org/apache/edgent/providers/iot/package-frame.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>org.apache.edgent.providers.iot (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>org.apache.edgent.providers.iot (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> http://git-wip-us.apache.org/repos/asf/incubator-edgent-website/blob/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/iot/package-summary.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/iot/package-summary.html b/site/javadoc/latest/org/apache/edgent/providers/iot/package-summary.html index 26c2754..ab55e94 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/iot/package-summary.html +++ b/site/javadoc/latest/org/apache/edgent/providers/iot/package-summary.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>org.apache.edgent.providers.iot (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>org.apache.edgent.providers.iot (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="org.apache.edgent.providers.iot (Edgent v1.1.0)"; + parent.document.title="org.apache.edgent.providers.iot (Apache Edgent (incubating) v1.2.0 API)"; } } catch(err) { @@ -90,8 +91,8 @@ <tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot">IotProvider</a></td> <td class="colLast"> -<div class="block">IoT provider supporting multiple topologies with a single connection to a - message hub.</div> +<div class="block">A provider that supports sharing of a single connection to an IoT message hub and + access to control MBeans via IoT device commands.</div> </td> </tr> </tbody> @@ -112,21 +113,24 @@ to be registered by name. Once registered an application can be started (and stopped) remotely through the control service using a device command. + <p>A jar may be registered remotely through a control service device command. + Applications in the jar are registered with the ApplicationService and may then be started and stopped + remotely. + <H3>Supported device commands</H3> This provider supports a number of system level device commands to control the applications running within it. <H4>Control service</H4> Device commands with the command identifier '<a href="../../../../../org/apache/edgent/connectors/iot/Commands.html#CONTROL_SERVICE"><code>edgentControl</code></a>' are sent to the provider's control service, an instance of <a href="../../../../../org/apache/edgent/runtime/jsoncontrol/JsonControlService.html" title="class in org.apache.edgent.runtime.jsoncontrol"><code>JsonControlService</code></a>. - This allows invocation of an operation against a control mbean registered with the + This allows invocation of an operation against a control MBean registered with the control service, either by an application or the provider itself. - <BR> + <P> The command's data (JSON) uniquely identifies a control MBean through its type and alias, and indicates the operation to call on the MBean and the arguments to pass to the operation. - <BR> Thus any control operation can be remotely invoked through a <code>edgentControl</code> device command, - including arbitrary control mbeans registered by applications. + including arbitrary control MBeans registered by applications. <H4 id="providerOps">Provider operations</H4> <table border="1" summary="Provider operations"> @@ -151,6 +155,21 @@ <tr></tr> <tr> + <td rowspan="2" headers="operation"><strong>Register an applications Jar</strong></td> + <td headers="cmdIdentifier"><code>edgentControl</code></td> + <td headers="type"><code>appService</code></td> + <td headers="alias"><code>edgent</code></td> + <td headers="op"><a href="../../../../../org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.html#registerJar-java.lang.String-java.lang.String-"><code>registerJar</code></a></td> + <td headers="args"><em><code>[jarURL, configJSONObject]</code></em></td> + <td headers="controlMbean"><a href="../../../../../org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.html" title="interface in org.apache.edgent.topology.mbeans"><code>ApplicationServiceMXBean</code></a></td> + </tr> + <tr> + <td headers="cmdIdentifier"><strong>Sample command data</strong></td> + <td colspan=5 headers="type alias op args controlMbean"><code>{"type":"appService","alias":"edgent","op":"registerJar","args":["https://myHost/path/to/myApp.jar",{}]}</code></td> + </tr> + <tr></tr> + + <tr> <td rowspan="2" headers="operation"><strong>Close (stop) a running registered application</strong></td> <td headers="cmdIdentifier"><code>edgentControl</code></td> <td headers="type"><code>job</code></td> @@ -164,6 +183,21 @@ <td colspan=5 headers="type alias op args controlMbean"><code>{"type":"job","alias":"Heartbeat","op":"stateChange","args":["CLOSE"]}</code></td> </tr> <tr></tr> + + <tr> + <td rowspan="2" headers="operation"><strong>Change a period control</strong></td> + <td headers="cmdIdentifier"><code>edgentControl</code></td> + <td headers="type"><em><code>varies</code></em></td> + <td headers="alias"><em><code>varies</code></em></td> + <td headers="op"><a href="../../../../../org/apache/edgent/execution/mbeans/PeriodMXBean.html#setPeriod-long-java.util.concurrent.TimeUnit-"><code>setPeriod</code></a></td> + <td headers="args"><em><code>[period, timeUnit]</code></em></td> + <td headers="controlMbean"><a href="../../../../../org/apache/edgent/execution/mbeans/PeriodMXBean.html" title="interface in org.apache.edgent.execution.mbeans"><code>PeriodMXBean</code></a></td> + </tr> + <tr> + <td headers="cmdIdentifier"><strong>Sample command data (TStream.poll())</strong></td> + <td colspan=5 headers="type alias op args controlMbean"><code>{"type":"stream","alias":"myStreamAlias","op":"setPeriod","args":[10, "SECONDS"]}</code></td> + </tr> + <tr></tr> </table></div> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> @@ -184,7 +218,6 @@ <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"> @@ -214,6 +247,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/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/iot/package-tree.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/iot/package-tree.html b/site/javadoc/latest/org/apache/edgent/providers/iot/package-tree.html index 00fc0e9..65050fe 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/iot/package-tree.html +++ b/site/javadoc/latest/org/apache/edgent/providers/iot/package-tree.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>org.apache.edgent.providers.iot Class Hierarchy (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>org.apache.edgent.providers.iot Class Hierarchy (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="org.apache.edgent.providers.iot Class Hierarchy (Edgent v1.1.0)"; + parent.document.title="org.apache.edgent.providers.iot Class Hierarchy (Apache Edgent (incubating) v1.2.0 API)"; } } catch(err) { @@ -79,7 +80,7 @@ <div class="contentContainer"> <h2 title="Class Hierarchy">Class Hierarchy</h2> <ul> -<li type="circle">java.lang.Object +<li type="circle">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"><span class="typeNameLink">Object</span></a> <ul> <li type="circle">org.apache.edgent.providers.iot.<a href="../../../../../org/apache/edgent/providers/iot/IotProvider.html" title="class in org.apache.edgent.providers.iot"><span class="typeNameLink">IotProvider</span></a> (implements org.apache.edgent.execution.<a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a><E,J>, org.apache.edgent.topology.<a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a>)</li> </ul> @@ -104,7 +105,6 @@ <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"> @@ -134,6 +134,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/a64ead3a/site/javadoc/latest/org/apache/edgent/providers/iot/package-use.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/providers/iot/package-use.html b/site/javadoc/latest/org/apache/edgent/providers/iot/package-use.html index 010ac2a..1807e44 100644 --- a/site/javadoc/latest/org/apache/edgent/providers/iot/package-use.html +++ b/site/javadoc/latest/org/apache/edgent/providers/iot/package-use.html @@ -2,9 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_112) on Sun Feb 26 17:08:13 EST 2017 --> -<title>Uses of Package org.apache.edgent.providers.iot (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 Package org.apache.edgent.providers.iot (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 Package org.apache.edgent.providers.iot (Edgent v1.1.0)"; + parent.document.title="Uses of Package org.apache.edgent.providers.iot (Apache Edgent (incubating) v1.2.0 API)"; } } catch(err) { @@ -72,43 +73,7 @@ <div class="header"> <h1 title="Uses of Package org.apache.edgent.providers.iot" class="title">Uses of Package<br>org.apache.edgent.providers.iot</h1> </div> -<div class="contentContainer"> -<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/providers/iot/package-summary.html">org.apache.edgent.providers.iot</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.scenarios.iotp">org.apache.edgent.samples.scenarios.iotp</a></td> -<td class="colLast"> </td> -</tr> -</tbody> -</table> -</li> -<li class="blockList"><a name="org.apache.edgent.samples.scenarios.iotp"> -<!-- --> -</a> -<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../../org/apache/edgent/providers/iot/package-summary.html">org.apache.edgent.providers.iot</a> used by <a href="../../../../../org/apache/edgent/samples/scenarios/iotp/package-summary.html">org.apache.edgent.samples.scenarios.iotp</a></span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Class and Description</th> -</tr> -<tbody> -<tr class="altColor"> -<td class="colOne"><a href="../../../../../org/apache/edgent/providers/iot/class-use/IotProvider.html#org.apache.edgent.samples.scenarios.iotp">IotProvider</a> -<div class="block">IoT provider supporting multiple topologies with a single connection to a - message hub.</div> -</td> -</tr> -</tbody> -</table> -</li> -</ul> -</div> +<div class="contentContainer">No usage of org.apache.edgent.providers.iot</div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> @@ -127,7 +92,6 @@ <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"> @@ -157,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/a64ead3a/site/javadoc/latest/org/apache/edgent/runtime/appservice/AppService.html ---------------------------------------------------------------------- diff --git a/site/javadoc/latest/org/apache/edgent/runtime/appservice/AppService.html b/site/javadoc/latest/org/apache/edgent/runtime/appservice/AppService.html index 04a9f71..b9ee342 100644 --- a/site/javadoc/latest/org/apache/edgent/runtime/appservice/AppService.html +++ b/site/javadoc/latest/org/apache/edgent/runtime/appservice/AppService.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>AppService (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:19 EST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AppService (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="AppService (Edgent v1.1.0)"; + parent.document.title="AppService (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.runtime.appservice.AppService</li> @@ -114,7 +115,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public class <span class="typeNameLabel">AppService</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/topology/services/ApplicationService.html" title="interface in org.apache.edgent.topology.services">ApplicationService</a></pre> <div class="block">Application service for a <code>TopologyProvider</code>. <BR> @@ -159,7 +160,7 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/appservice/AppService.html#AppService-org.apache.edgent.topology.TopologyProvider-org.apache.edgent.execution.DirectSubmitter-java.lang.String-">AppService</a></span>(<a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a> provider, <a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submitter, - java.lang.String alias)</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> alias)</code> <div class="block">Create an <code>ApplicationService</code> instance.</div> </td> </tr> @@ -186,22 +187,22 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati </td> </tr> <tr id="i1" class="rowColor"> -<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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/runtime/appservice/AppService.html#getApplicationNames--">getApplicationNames</a></span>()</code> <div class="block">Returns the names of applications registered with this service.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/appservice/AppService.html#registerJar-java.lang.String-java.lang.String-">registerJar</a></span>(java.lang.String jarURL, - java.lang.String jsonConfig)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/appservice/AppService.html#registerJar-java.lang.String-java.lang.String-">registerJar</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> jarURL, + <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> jsonConfig)</code> <div class="block">Create a new class loader for the jar and register any topology application that is registered as a service provider.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/appservice/AppService.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-">registerTopology</a></span>(java.lang.String applicationName, +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/edgent/runtime/appservice/AppService.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-">registerTopology</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> applicationName, <a href="../../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,com.google.gson.JsonObject> builder)</code> <div class="block">Add a topology that can be started though a control mbean.</div> </td> @@ -211,8 +212,8 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <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> @@ -236,7 +237,7 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <h4>AppService</h4> <pre>public AppService(<a href="../../../../../org/apache/edgent/topology/TopologyProvider.html" title="interface in org.apache.edgent.topology">TopologyProvider</a> provider, <a href="../../../../../org/apache/edgent/execution/DirectSubmitter.html" title="interface in org.apache.edgent.execution">DirectSubmitter</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,<a href="../../../../../org/apache/edgent/execution/Job.html" title="interface in org.apache.edgent.execution">Job</a>> submitter, - java.lang.String alias)</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> alias)</pre> <div class="block">Create an <code>ApplicationService</code> instance.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -278,7 +279,7 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <ul class="blockList"> <li class="blockList"> <h4>registerTopology</h4> -<pre>public void registerTopology(java.lang.String applicationName, +<pre>public void registerTopology(<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> applicationName, <a href="../../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../../org/apache/edgent/topology/Topology.html" title="interface in org.apache.edgent.topology">Topology</a>,com.google.gson.JsonObject> builder)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/topology/services/ApplicationService.html#registerTopology-java.lang.String-org.apache.edgent.function.BiConsumer-">ApplicationService</a></code></span></div> <div class="block">Add a topology that can be started though a control mbean. @@ -318,9 +319,9 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <ul class="blockList"> <li class="blockList"> <h4>registerJar</h4> -<pre>public void registerJar(java.lang.String jarURL, - java.lang.String jsonConfig) - throws java.lang.Exception</pre> +<pre>public void registerJar(<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> jarURL, + <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> jsonConfig) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block">Create a new class loader for the jar and register any topology application that is registered as a service provider.</div> <dl> @@ -330,7 +331,9 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <dd><code>jarURL</code> - URL of Jar containing new applications.</dd> <dd><code>jsonConfig</code> - JSON configuration serialized as a String (currently unused).</dd> <dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.lang.Exception</code> - if failure</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - if failure</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/util/ServiceLoader.html?is-external=true"; title="class or interface in java.util"><code>ServiceLoader</code></a></dd> </dl> </li> </ul> @@ -340,7 +343,7 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <ul class="blockListLast"> <li class="blockList"> <h4>getApplicationNames</h4> -<pre>public java.util.Set<java.lang.String> getApplicationNames()</pre> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> getApplicationNames()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/edgent/topology/services/ApplicationService.html#getApplicationNames--">ApplicationService</a></code></span></div> <div class="block">Returns the names of applications registered with this service.</div> <dl> @@ -376,7 +379,6 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <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"> @@ -421,6 +423,6 @@ implements <a href="../../../../../org/apache/edgent/topology/services/Applicati <!-- --> </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>
