You must have Java 8 installed on your system. Maven will be automatically downloaded and installed by the maven wrapper
Build the samples for Java 8
./mvnw clean package
Run the HelloEdgent sample
cd topology ./run-sample.sh HelloEdgent # prints a hello message and terminates Hello Edgent! ...
The Edgent samples provide a starting point for jump starting your use of Edgent. See the Samples Summary section for a list of the samples.
The Edgent samples are organized into a few categories (subdirectories) and are a collection of maven projects. They can be built using maven or other maven-integrated tooling such as Eclipse.
An Edgent application template maven project is supplied. It may be a useful starting point to clone for your application. The template has a standalone maven project pom, rather than a stylized one used by the rest of the samples. See template/README.md.
See APPLICATION_DEVELOPMENT.md for general information on Edgent Application Development, Packaging and Execution.
Additional information may also be found in Getting Started https://edgent.apache.org/docs/edgent-getting-started
Once you have downloaded and unpacked the samples source bundle or cloned the the samples repository you need to download these additional development software tools.
Maven is used as build tool and a maven-wrapper script (
mvnw.bat) is included.
The maven-wrapper automatically downloads and installs the correct Maven version and use it. Besides this, there is no difference between using the
mvnw command and the
You may also use a maven-integrated IDE with the samples. e.g., see the Using Eclipse section below.
The samples use Edgent SDK jars that have been released in a maven repository such as Maven Central.
Alternatively, you can download the Edgent SDK sources and build them, populating your local maven repository. The samples will then use those Edgent SDK jars. Adjust the
edgent.version property in the top level samples
pom.xml accordingly. See downloads for downloading the Edgent SDK sources.
By default Java8 class files are generated. Java7 platform class files are produced when the appropriate profile is specified.
Currently, building and running the samples for the Android platform is not supported. Many samples happen to use the
DevelopmentProvider, which is not supported on the Android platform.
Build the samples
./mvnw clean package # -Pplatform-java7 as needed
A standard jar and uber jar are created for each sample category in the sample category's target directory:
README.md in each sample category directory for information on running the samples.
The Edgent Git repository and samples source release bundle contains Maven project definitions for the samples.
Once you import the Maven projects into your workspace, builds in Eclipse use the same artifacts as the Maven command line tooling. Like the command line tooling, the jars for dependent projects are automatically downloaded to the local maven repository and used.
If you want to use Eclipse to clone your fork, use the Eclipse Git Team Provider plugin
firstname.lastname@example.org:<username>/incubator-edgent.git). The other fields will be populated automatically. Click Next. If required, enter your passphrase.
master) and click Next
Once you have cloned the Git repository to your machine or are working from an unpacked samples source release bundle, import the Maven projects into your workspace
samplesdirectory in the clone or source release directory and select it. A hierarchy of samples projects / pom.xml files will be listed and all selected.
Top-level artifacts such as
README.md are available under the
Note: Specifics may change depending on your version of Eclipse or the Eclipse Maven or Git Team Provider.
Once the samples projects have been imported you can run them from Eclipse in the usual manner. E.g.,
HelloEdgentand click OK
HelloEdgentclass name and from the context menu
HelloEdgentruns and prints to the Console view.
Many other samples are provided but have not yet been noted above. Explore!
Apache Edgent samples are released under the Apache License Version 2.0.
Apache Edgent is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.