Repository: incubator-edgent Updated Branches: refs/heads/master fc851f8c6 -> f43ec0846
[Edgent-406] improve ApplicationServiceMXBean.registerJar() doc Project: http://git-wip-us.apache.org/repos/asf/incubator-edgent/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-edgent/commit/bfa91672 Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent/tree/bfa91672 Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent/diff/bfa91672 Branch: refs/heads/master Commit: bfa9167290e63504f513b867d696dcb9ee4d7479 Parents: dfee275 Author: Dale LaBossiere <dlab...@us.ibm.com> Authored: Thu Mar 30 16:27:48 2017 -0400 Committer: Dale LaBossiere <dlab...@us.ibm.com> Committed: Thu Mar 30 16:27:48 2017 -0400 ---------------------------------------------------------------------- .../edgent/topology/mbeans/ApplicationServiceMXBean.java | 9 +++++---- .../edgent/topology/services/ApplicationService.java | 10 ++++++---- 2 files changed, 11 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/bfa91672/api/topology/src/main/java/org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.java ---------------------------------------------------------------------- diff --git a/api/topology/src/main/java/org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.java b/api/topology/src/main/java/org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.java index 34faa2f..03dac32 100644 --- a/api/topology/src/main/java/org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.java +++ b/api/topology/src/main/java/org/apache/edgent/topology/mbeans/ApplicationServiceMXBean.java @@ -44,12 +44,13 @@ public interface ApplicationServiceMXBean { /** * Register a jar file containing applications with - * the application service. Any service providers - * in the jar of type {@link TopologyBuilder} will - * be registered as applications. + * the application service. + * + * <p>See {@link ApplicationService#registerJar(String, String) ApplicationService.registerJar()} + * for further semantics and requirements on the jar. * * @param jarURL URL for the jar file. - * @param jsonConfig JsonObject configuration serialized as a JSON String (currently unused). + * @param jsonConfig JsonObject configuration serialized as a JSON String. * Null or an empty String is equivalent to an empty JSON object. * @throws Exception Error registering jar. * http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/bfa91672/api/topology/src/main/java/org/apache/edgent/topology/services/ApplicationService.java ---------------------------------------------------------------------- diff --git a/api/topology/src/main/java/org/apache/edgent/topology/services/ApplicationService.java b/api/topology/src/main/java/org/apache/edgent/topology/services/ApplicationService.java index b30497b..7cec4ee 100644 --- a/api/topology/src/main/java/org/apache/edgent/topology/services/ApplicationService.java +++ b/api/topology/src/main/java/org/apache/edgent/topology/services/ApplicationService.java @@ -28,7 +28,6 @@ import org.apache.edgent.topology.mbeans.ApplicationServiceMXBean; import com.google.gson.JsonObject; /** - * Application registration service. * A service that allows registration of applications and * the ability to submit them through a control MBean. * @@ -78,9 +77,10 @@ public interface ApplicationService { /** * Register a jar file containing new applications. - * Any service provider within the jar of type {@link TopologyBuilder} - * will be {@link #registerTopology(String, BiConsumer) registered} as - * a topology. + * + * <p>Any {@link java.util.ServiceLoader service provider} + * within the jar of type {@link TopologyBuilder} + * will be {@link #registerTopology(String, BiConsumer) registered}. * * The jar cannot have any new dependencies, its classpath will * be the classpath of this service. @@ -88,6 +88,8 @@ public interface ApplicationService { * @param jarURL URL of Jar containing new applications. * @param jsonConfig JSON configuration serialized as a String (currently unused). * @throws Exception if failure + * + * @see java.util.ServiceLoader */ void registerJar(String jarURL, String jsonConfig) throws Exception;
