/client-samples

Client samples to run with Gluon Client plugins for Maven and Gradle

Primary LanguageJavaOtherNOASSERTION

Gluon Client Samples

Java and JavaFX samples to run with GraalVM and the Gluon Client plugins for Maven.

For now only Linux, Mac OS X, iOS and Android platforms are supported.

Build and run the samples on Linux and Mac OS X

Requirements

  • Install the Java 11 based GraalVM 20.0.0: download the appropriate Community Edition archive from https://github.com/oracle/graal/releases, and unpack it like you would any other JDK.

  • Configure the runtime environment. Set GRAALVM_HOME environment variable to the GraalVM installation directory.

For example:

export GRAALVM_HOME=/path-to-your-graalvm

On macOS, point the variable to the Home sub-directory:

export GRAALVM_HOME=/path-to-your-graalvm/Contents/Home
  • Set JAVA_HOME to point to the GraalVM installation directory.

For example:

export JAVA_HOME=$GRAALVM_HOME
  • Install the native-image tool.

Using gu install:

${GRAALVM_HOME}/bin/gu install native-image

Build using Maven

HelloWorld, HelloFX, HelloFXML and HelloGluon samples

The following goals apply to Linux and Mac OS X.

To build the native image:

mvn clean client:build

To run the native image:

mvn client:run

or simply run the native executable found in target/client

Build and run the samples on iOS

Requirements

For example:

export GRAALVM_HOME=/opt/graalvm-svm-darwin-20.1.0-ea+26
  • Set JAVA_HOME to point to the GraalVM installation directory

For example:

export JAVA_HOME=$GRAALVM_HOME

  • Install Homebrew, if you haven't already. Please refer to https://brew.sh/ for more information.

  • Install libusbmuxd

Using brew:

brew install --HEAD libusbmuxd
  • Install libimobiledevice

Using brew:

brew install --HEAD libimobiledevice

Build using Maven

HelloWorld, HelloFX, HelloFXML and HelloGluon samples

  • Change the target to ios (for iOS devices) in the pom.xml:
<artifactId>client-maven-plugin</artifactId>
<configuration>
    <target>ios</target>
    <mainClass>${mainClassName}</mainClass>
</configuration>
  • Build the native image:
mvn clean client:build
  • Package and create an IPA file:
mvn client:package
  • Install the IPA file on a connected iOS device:
mvn client:install
  • Run the installed app on the connected iOS device:
mvn client:run

Note: Since all java bytecode is translated to native code, the compilation step can take a long time, and it requires a fair amount of memory.

Note: In order to deploy apps to an iOS device, you need a valid iOS provisioning profile, as explained in the documentation.

Build and run the samples on Android

Requirements

  • Android can be built only on Linux OS and requires a custom GraalVM Linux SDK
  • Set GRAALVM_HOME environment variable to the GraalVM installation directory
  • Set JAVA_HOME to point to the GraalVM installation directory

The client plugin will download the Android SDK and install the required packages. If needed, you can define the location to the Android SDK by setting the ANDROID_SDK environment variable, making sure that you have installed all the packages from the following list:

  • platforms;android-27
  • platform-tools
  • build-tools;27.0.3
  • ndk-bundle
  • extras;android;m2repository
  • extras;google;m2repository

Build using Maven

HelloWorld, HelloFX, HelloFXML and HelloGluon samples

  • Change the target to android (for android devices) in pom.xml:
<artifactId>client-maven-plugin</artifactId>
<configuration>
    <target>android</target>
    <mainClass>${mainClassName}</mainClass>
</configuration>
  • Build the native image:
mvn clean client:build
  • Package and create an APK file:
mvn client:package
  • Install the APK file on a connected Android device:
mvn client:install
  • Run the installed app on the connected Android device:
mvn client:run

Note: Since all java bytecode is translated to native code, the compilation step can take a long time, and it requires a fair amount of memory.

Issues and Contributions

Issues can be reported to the Issue tracker

Contributions can be submitted via Pull requests, providing you have signed the Gluon Individual Contributor License Agreement (CLA) (See What is a CLA and why do I care in case of doubt).