[gRPC] Add java example
This showcases how you would use gRPC from java with gradle.
$ gradle run
will list the snapshots.
Change-Id: I6565657d01695c6734749454ac1b164732d99707
diff --git a/android/android-grpc/docs/java/.gitattributes b/android/android-grpc/docs/java/.gitattributes
new file mode 100644
index 0000000..00a51af
--- /dev/null
+++ b/android/android-grpc/docs/java/.gitattributes
@@ -0,0 +1,6 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# These are explicitly windows files and should use crlf
+*.bat text eol=crlf
+
diff --git a/android/android-grpc/docs/java/.gitignore b/android/android-grpc/docs/java/.gitignore
new file mode 100644
index 0000000..1b6985c
--- /dev/null
+++ b/android/android-grpc/docs/java/.gitignore
@@ -0,0 +1,5 @@
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+build
diff --git a/android/android-grpc/docs/java/build.gradle b/android/android-grpc/docs/java/build.gradle
new file mode 100644
index 0000000..aed8e3a
--- /dev/null
+++ b/android/android-grpc/docs/java/build.gradle
@@ -0,0 +1,77 @@
+/*
+ * This file was generated by the Gradle 'init' task.
+ *
+ * This generated file contains a sample Java project to get you started.
+ * For more details take a look at the Java Quickstart chapter in the Gradle
+ * User Manual available at https://docs.gradle.org/6.0.1/userguide/tutorial_java_projects.html
+ */
+
+plugins {
+ // Apply the java plugin to add support for Java
+ id 'java'
+
+ // Apply the application plugin to add support for building a CLI application.
+ id 'application'
+
+ id 'com.google.protobuf' version '0.8.8'
+ // Generate IntelliJ IDEA's .idea & .iml project files
+ id 'idea'
+}
+
+repositories {
+ // Use jcenter for resolving dependencies.
+ // You can declare any Maven/Ivy/file repository here.
+ jcenter()
+ maven { // The google mirror is less flaky than mavenCentral()
+ url "https://maven-central.storage-download.googleapis.com/repos/central/data/" }
+ mavenCentral()
+ mavenLocal()
+}
+
+// Feel free to delete the comment at the next line. It is just for safely
+// updating the version in our release process.
+def grpcVersion = '1.26.0' // CURRENT_GRPC_VERSION
+def protobufVersion = '3.11.0'
+def protocVersion = protobufVersion
+
+dependencies {
+ implementation "io.grpc:grpc-protobuf:${grpcVersion}"
+ implementation "io.grpc:grpc-stub:${grpcVersion}"
+ implementation "com.android.tools.ddms:ddmlib:22.0"
+
+ compileOnly "javax.annotation:javax.annotation-api:1.2"
+
+ // examples/advanced need this for JsonFormat
+ implementation "com.google.protobuf:protobuf-java-util:${protobufVersion}"
+
+ runtimeOnly "io.grpc:grpc-netty-shaded:${grpcVersion}"
+
+ testImplementation "io.grpc:grpc-testing:${grpcVersion}"
+ testImplementation "junit:junit:4.12"
+ testImplementation "org.mockito:mockito-core:2.28.2"
+}
+
+protobuf {
+ protoc { artifact = "com.google.protobuf:protoc:${protocVersion}" }
+ plugins {
+ grpc { artifact = "io.grpc:protoc-gen-grpc-java:${grpcVersion}" }
+ }
+ generateProtoTasks {
+ all()*.plugins { grpc {} }
+ }
+}
+
+// Inform IDEs like IntelliJ IDEA, Eclipse or NetBeans about the generated code.
+sourceSets {
+ main {
+ java {
+ srcDirs 'build/generated/source/proto/main/grpc'
+ srcDirs 'build/generated/source/proto/main/java'
+ }
+ }
+}
+
+application {
+ // Define the main class for the application.
+ mainClassName = 'com.android.emulator.SnapshotSample'
+}
diff --git a/android/android-grpc/docs/java/gradle/wrapper/gradle-wrapper.jar b/android/android-grpc/docs/java/gradle/wrapper/gradle-wrapper.jar
new file mode 100644
index 0000000..cc4fdc2
--- /dev/null
+++ b/android/android-grpc/docs/java/gradle/wrapper/gradle-wrapper.jar
Binary files differ
diff --git a/android/android-grpc/docs/java/gradle/wrapper/gradle-wrapper.properties b/android/android-grpc/docs/java/gradle/wrapper/gradle-wrapper.properties
new file mode 100644
index 0000000..9492014
--- /dev/null
+++ b/android/android-grpc/docs/java/gradle/wrapper/gradle-wrapper.properties
@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.0.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
diff --git a/android/android-grpc/docs/java/gradlew b/android/android-grpc/docs/java/gradlew
new file mode 100755
index 0000000..2fe81a7
--- /dev/null
+++ b/android/android-grpc/docs/java/gradlew
@@ -0,0 +1,183 @@
+#!/usr/bin/env sh
+
+#
+# Copyright 2015 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+##
+## Gradle start up script for UN*X
+##
+##############################################################################
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+ ls=`ls -ld "$PRG"`
+ link=`expr "$ls" : '.*-> \(.*\)$'`
+ if expr "$link" : '/.*' > /dev/null; then
+ PRG="$link"
+ else
+ PRG=`dirname "$PRG"`"/$link"
+ fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >/dev/null
+APP_HOME="`pwd -P`"
+cd "$SAVED" >/dev/null
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn () {
+ echo "$*"
+}
+
+die () {
+ echo
+ echo "$*"
+ echo
+ exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "`uname`" in
+ CYGWIN* )
+ cygwin=true
+ ;;
+ Darwin* )
+ darwin=true
+ ;;
+ MINGW* )
+ msys=true
+ ;;
+ NONSTOP* )
+ nonstop=true
+ ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+ if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+ # IBM's JDK on AIX uses strange locations for the executables
+ JAVACMD="$JAVA_HOME/jre/sh/java"
+ else
+ JAVACMD="$JAVA_HOME/bin/java"
+ fi
+ if [ ! -x "$JAVACMD" ] ; then
+ die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+ fi
+else
+ JAVACMD="java"
+ which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
+ MAX_FD_LIMIT=`ulimit -H -n`
+ if [ $? -eq 0 ] ; then
+ if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+ MAX_FD="$MAX_FD_LIMIT"
+ fi
+ ulimit -n $MAX_FD
+ if [ $? -ne 0 ] ; then
+ warn "Could not set maximum file descriptor limit: $MAX_FD"
+ fi
+ else
+ warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+ fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+ GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
+ APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+ CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+ JAVACMD=`cygpath --unix "$JAVACMD"`
+
+ # We build the pattern for arguments to be converted via cygpath
+ ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+ SEP=""
+ for dir in $ROOTDIRSRAW ; do
+ ROOTDIRS="$ROOTDIRS$SEP$dir"
+ SEP="|"
+ done
+ OURCYGPATTERN="(^($ROOTDIRS))"
+ # Add a user-defined pattern to the cygpath arguments
+ if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+ OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+ fi
+ # Now convert the arguments - kludge to limit ourselves to /bin/sh
+ i=0
+ for arg in "$@" ; do
+ CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+ CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
+
+ if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
+ eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+ else
+ eval `echo args$i`="\"$arg\""
+ fi
+ i=`expr $i + 1`
+ done
+ case $i in
+ 0) set -- ;;
+ 1) set -- "$args0" ;;
+ 2) set -- "$args0" "$args1" ;;
+ 3) set -- "$args0" "$args1" "$args2" ;;
+ 4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+ 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+ 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+ 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+ 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+ 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+ esac
+fi
+
+# Escape application args
+save () {
+ for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
+ echo " "
+}
+APP_ARGS=`save "$@"`
+
+# Collect all arguments for the java command, following the shell quoting and substitution rules
+eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+
+exec "$JAVACMD" "$@"
diff --git a/android/android-grpc/docs/java/gradlew.bat b/android/android-grpc/docs/java/gradlew.bat
new file mode 100644
index 0000000..9618d8d
--- /dev/null
+++ b/android/android-grpc/docs/java/gradlew.bat
@@ -0,0 +1,100 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%" == "" @echo off
+@rem ##########################################################################
+@rem
+@rem Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%" == "" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if "%ERRORLEVEL%" == "0" goto init
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto init
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:init
+@rem Get command-line arguments, handling Windows variants
+
+if not "%OS%" == "Windows_NT" goto win9xME_args
+
+:win9xME_args
+@rem Slurp the command line arguments.
+set CMD_LINE_ARGS=
+set _SKIP=2
+
+:win9xME_args_slurp
+if "x%~1" == "x" goto execute
+
+set CMD_LINE_ARGS=%*
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+
+:end
+@rem End local scope for the variables with windows NT shell
+if "%ERRORLEVEL%"=="0" goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
+exit /b 1
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega
diff --git a/android/android-grpc/docs/java/settings.gradle b/android/android-grpc/docs/java/settings.gradle
new file mode 100644
index 0000000..031370f
--- /dev/null
+++ b/android/android-grpc/docs/java/settings.gradle
@@ -0,0 +1,10 @@
+/*
+ * This file was generated by the Gradle 'init' task.
+ *
+ * The settings file is used to specify which projects to include in your build.
+ *
+ * Detailed information about configuring a multi-project build in Gradle can be found
+ * in the user manual at https://docs.gradle.org/6.0.1/userguide/multi_project_builds.html
+ */
+
+rootProject.name = 'gRPC_Sample'
diff --git a/android/android-grpc/docs/java/src/main/java/com/android/emulator/EmulatorGrpc.java b/android/android-grpc/docs/java/src/main/java/com/android/emulator/EmulatorGrpc.java
new file mode 100644
index 0000000..263ce78
--- /dev/null
+++ b/android/android-grpc/docs/java/src/main/java/com/android/emulator/EmulatorGrpc.java
@@ -0,0 +1,69 @@
+/*
+ * This Java source file was generated by the Gradle 'init' task.
+ */
+package com.android.emulator;
+
+import io.grpc.ManagedChannel;
+import io.grpc.ManagedChannelBuilder;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+
+
+public class EmulatorGrpc {
+
+ private static class IntClosure {
+ public int value = 0;
+ }
+
+ /**
+ * Start & extract grpc on a random available port.
+ *
+ * @return The grpc port or -1 if we couldn't start/get it.
+ * @throws InterruptedException
+ * @throws IOException
+ */
+ private static int startGrpc() throws InterruptedException, IOException {
+ IntClosure port = new IntClosure();
+ ProcessBuilder builder = new ProcessBuilder();
+ builder.command("adb", "emu", "grpc", "0");
+ Process process = builder.start();
+ Runnable r = () -> {
+ BufferedReader br = new BufferedReader(new InputStreamReader(process.getInputStream()));
+ br.lines().forEach(x -> {
+ // Super have to extract:
+ // OK: gRPC endpoint available at port 12345
+ String[] parts = x.split(" ");
+ if (parts.length == 7 && parts[5].equals("port")) {
+ port.value = Integer.parseInt((parts[6]));
+ }
+ });
+ };
+ Thread thread = new Thread(r);
+ thread.start();
+ int exitCode = process.waitFor();
+ if (exitCode != 0)
+ return -1;
+
+ thread.join();
+ return port.value;
+ }
+
+ public static SnapshotServiceGrpc.SnapshotServiceBlockingStub getSnapshotServiceStub() throws IOException, InterruptedException {
+ int grpcPort = startGrpc();
+ System.out.println("Grpc at port: " + grpcPort);
+ return getSnapshotServiceStub(grpcPort);
+ }
+
+ public static SnapshotServiceGrpc.SnapshotServiceBlockingStub getSnapshotServiceStub(int port) throws IOException, InterruptedException {
+
+ ManagedChannel channel = ManagedChannelBuilder.forAddress("localhost", port)
+ // Channels are secure by default (via SSL/TLS). For the example we disable TLS to avoid
+ // needing certificates. Note, emulator has the certs in ~/.android if its using them.
+ .usePlaintext()
+ .build();
+ return SnapshotServiceGrpc.newBlockingStub(channel);
+ }
+}
+
diff --git a/android/android-grpc/docs/java/src/main/java/com/android/emulator/SnapshotSample.java b/android/android-grpc/docs/java/src/main/java/com/android/emulator/SnapshotSample.java
new file mode 100644
index 0000000..3c03f24
--- /dev/null
+++ b/android/android-grpc/docs/java/src/main/java/com/android/emulator/SnapshotSample.java
@@ -0,0 +1,25 @@
+/*
+ * This Java source file was generated by the Gradle 'init' task.
+ */
+package com.android.emulator;
+
+import com.google.protobuf.Empty;
+
+import java.io.IOException;
+import java.util.List;
+
+public class SnapshotSample {
+
+ public static void main(String[] args) throws IOException, InterruptedException {
+ // Get the grpc service
+ SnapshotServiceGrpc.SnapshotServiceBlockingStub service = EmulatorGrpc.getSnapshotServiceStub();
+
+ // Make a grpc call.
+ List<SnapshotDetails> snapshots = service.listSnapshots(Empty.getDefaultInstance()).getSnapshotsList();
+
+ // List results.
+ for(SnapshotDetails snapshot : snapshots) {
+ System.out.println(snapshot);
+ }
+ }
+}
diff --git a/android/android-grpc/docs/java/src/main/proto/emulator_controller.proto b/android/android-grpc/docs/java/src/main/proto/emulator_controller.proto
new file mode 120000
index 0000000..1db1b07
--- /dev/null
+++ b/android/android-grpc/docs/java/src/main/proto/emulator_controller.proto
@@ -0,0 +1 @@
+../../../../../emulator_controller.proto
\ No newline at end of file
diff --git a/android/android-grpc/docs/java/src/main/proto/snapshot-service.proto b/android/android-grpc/docs/java/src/main/proto/snapshot-service.proto
new file mode 120000
index 0000000..b46d975
--- /dev/null
+++ b/android/android-grpc/docs/java/src/main/proto/snapshot-service.proto
@@ -0,0 +1 @@
+../../../../../snapshot-service.proto
\ No newline at end of file
diff --git a/android/android-grpc/docs/java/src/main/proto/snapshot.proto b/android/android-grpc/docs/java/src/main/proto/snapshot.proto
new file mode 120000
index 0000000..c8f8a07
--- /dev/null
+++ b/android/android-grpc/docs/java/src/main/proto/snapshot.proto
@@ -0,0 +1 @@
+../../../../../../.././android/android-emu/android/snapshot/proto/snapshot.proto
\ No newline at end of file
